com.businessobjects.rebean.wi
Interface DrillPath

public interface DrillPath

The DrillPath interface provides access to the drill up/down/slice/by operations. This interface is used only in drill mode.

See Also:

DrillOption

Method Summary

DrillActionType	getAction() Returns the drill action type specified by the user.
java.lang.String	getBlockID() Returns the block ID you want to drill in.
DrillElements	getFrom() Returns a new list you have to fill with DrillDimensions.
DrillElements	getTo() Returns a new list you have to fille with DrillDimensions.
void	setAction(DrillActionType action) Specifies the drill action type.
void	setBlockID(java.lang.String blockID) Sets the Block Id you want to drill in (optional).

Method Detail

getBlockID

java.lang.String getBlockID()

Returns the block ID you want to drill in.

Returns:

the block ID you want to drill in.

setBlockID

void setBlockID(java.lang.String blockID)

Sets the Block Id you want to drill in (optional). you do not need to set a blockID. If not, your drill action will have effect on all the current report.

Parameters:

blockID - The block ID you want to drill in.

getAction

DrillActionType getAction()

Returns the drill action type specified by the user.

Returns:

the drill action type specified by the user.

setAction

void setAction(DrillActionType action)

Specifies the drill action type. This method is mandatory. There is no default values.

getFrom

DrillElements getFrom()

Returns a new list you have to fill with DrillDimensions. This DrillElements must be filled with DrillFromElement. You have to add in this list all dimensions the user want to drill from.

getTo

DrillElements getTo()

Returns a new list you have to fille with DrillDimensions. This DrillElements must be filled with DrillToElement. You have to add in this list all dimensions the user want to drill to.