com.sas.commands.dataselectors
Class OLAPTimeBasedFilterCommand

com.sas.commands.dataselectors.OLAPTimeBasedFilterCommand

All Implemented Interfaces:

CommandStatusInterface, CancelInterface, ContentsChangedInterface, DataSelectorCommandInterface, DynamicAttributeCommandInterface, PendingCommandInterface, BaseEntityInterface, BaseEntityValueInterface, EntityKeyInterface, com.sas.lang.StringDataInterface, com.sas.PublicClonable, com.sas.util.Command, com.sas.util.SimpleCommand, java.lang.Cloneable, java.rmi.Remote

public class OLAPTimeBasedFilterCommand
implements CommandStatusInterface

Field Summary

protected boolean	isRefreshBusinessQueryOnCommit
protected java.lang.String	remoteAction

Fields inherited from class com.sas.commands.dataselectors.BaseSelectorCommand

actionClass, CANCEL_MODE, COMMIT_MODE, complete, contentsChanged, eventInfo, eventSource, modal, mode, model, PROCESS_MODE, selector, selectorModel, SHOW_MODE

Fields inherited from interface com.sas.actionprovider.CommandStatusInterface

DISABLED, ENABLED, IS_CURRENT_STATE_DISABLED, MODEL_MEMBER_DISABLED, MODEL_STATE_DISABLED, MODEL_TYPE_DISABLED

Fields inherited from interface com.sas.commands.DynamicAttributeCommandInterface

COMMAND_NAME_PREFIX

Constructor Summary

OLAPTimeBasedFilterCommand()

OLAPTimeBasedFilterCommand(boolean isRefreshBusinessQueryOnCommit)

OLAPTimeBasedFilterCommand(java.lang.String name)
Constructor that accepts a command name

OLAPTimeBasedFilterCommand(java.lang.String name, boolean swing)
Constructor that accepts a command name and boolean attribute for specifying the swing attribute.

OLAPTimeBasedFilterCommand(java.lang.String name, java.lang.String actionClass)
Constructor that accepts a command name and an action class type

Method Summary

void	cancel(java.lang.Object o) Cancel is called when the user clicks on the cancel button on the selector or another selector becomes active.
protected void	commit(java.lang.Object o)
protected OLAPTimeBasedFilterAdapterInterface	createAdapter(java.lang.Object model)
int	getCommandStatus(ActionSupportFilter actionFilter) Returns a status value indicating whether the command is enabled for a specific area as described by various filter attributes.
java.lang.String	getEndingPeriodOption()
java.lang.String	getNumberOfPeriods()
java.lang.String	getPeriodType()
java.lang.String	getRemoteAction()
java.lang.String	getSelectedEndingPeriod()
java.lang.String[]	getSelectedPeriods()
java.lang.String	getSelectedStartingPeriod()
java.lang.String	getSelectOption()
java.lang.String	getShowOption()
java.lang.String	getStartingPeriodOption()
boolean	isSwing() Returns the swing attribute which should be true when the command is used in a swing environment, false otherwise.
protected void	process(java.lang.Object o) Processes the request object to manipulate the model.
void	setEndingPeriodOption(java.lang.String value)
void	setNumberOfPeriods(java.lang.String value)
void	setPanelVisible(boolean visible) Indicates if the OLAPTimeBasedFilterSelectorPanel should or should not be displayed
void	setPeriodType(java.lang.String value)
void	setRemoteAction(java.lang.String value)
void	setSelectedEndingPeriod(java.lang.String value)
void	setSelectedPeriods(java.lang.String[] values)
void	setSelectedStartingPeriod(java.lang.String value)
void	setSelectOption(java.lang.String value)
void	setShowOption(java.lang.String value)
void	setStartingPeriodOption(java.lang.String value)
void	setSwing(boolean swing) Sets the swing attribute which should be true when the command is used in a swing environment, false otherwise.
protected void	show(java.lang.Object o) Creates the selector model and sets it on the selector.

Methods inherited from class com.sas.commands.dataselectors.BaseSelectorCommand

cancel, closeSelector, execute, getEventInfo, getEventSource, getMode, getModel, getSelector, getSelectorModel, isComplete, isContentsChanged, isModal, setComplete, setModal, setMode, setModel, setSelector, setSelectorModel

Methods inherited from class com.sas.commands.BaseCommand

getLocale, getName, getNextCommandName, getText, isExecutable, isUndoable, setLocale, setName, setText, undo

Methods inherited from class com.sas.entities.BaseEntity

clone, containsAttributeNamed, equals, equals, getAttribute, getAttribute, getAttributeCount, getAttributes, getEntityKey, getPropertyDescriptors, getStringAttribute, listAttributeNames, removeAllAttributes, removeAttribute, reset, sameEntity, setAttribute, setAttributes, setEntityKey, toString

Methods inherited from interface com.sas.entities.BaseEntityValueInterface

getAttribute, setAttribute

Methods inherited from interface com.sas.util.Command

clone

Field Detail

remoteAction

protected java.lang.String remoteAction

isRefreshBusinessQueryOnCommit

protected boolean isRefreshBusinessQueryOnCommit

Constructor Detail

OLAPTimeBasedFilterCommand

public OLAPTimeBasedFilterCommand()

OLAPTimeBasedFilterCommand

public OLAPTimeBasedFilterCommand(boolean isRefreshBusinessQueryOnCommit)

OLAPTimeBasedFilterCommand

public OLAPTimeBasedFilterCommand(java.lang.String name)

Constructor that accepts a command name

OLAPTimeBasedFilterCommand

public OLAPTimeBasedFilterCommand(java.lang.String name,
                                  java.lang.String actionClass)

Constructor that accepts a command name and an action class type

OLAPTimeBasedFilterCommand

public OLAPTimeBasedFilterCommand(java.lang.String name,
                                  boolean swing)

Constructor that accepts a command name and boolean attribute for specifying the swing attribute.

Parameters:

name - the command's name

swing - true if command used in a Swing environment, false otherwise;

Method Detail

show

protected void show(java.lang.Object o)

Creates the selector model and sets it on the selector. This is typically run when the selector dialog is initially displayed.

Overrides:

show in class BaseSelectorCommand

Throws:

java.lang.IllegalStateException - thrown if no selector is not set

cancel

public void cancel(java.lang.Object o)

Cancel is called when the user clicks on the cancel button on the selector or another selector becomes active. Sets the selector visible property to false so the selector window gets closed.

Overrides:

cancel in class BaseSelectorCommand

commit

protected void commit(java.lang.Object o)
               throws java.io.IOException

Overrides:

commit in class BaseSelectorCommand

Throws:

java.io.IOException

createAdapter

protected OLAPTimeBasedFilterAdapterInterface createAdapter(java.lang.Object model)

getCommandStatus

public int getCommandStatus(ActionSupportFilter actionFilter)

Description copied from interface: CommandStatusInterface

Returns a status value indicating whether the command is enabled for a specific area as described by various filter attributes.

If enabled, the value is: CommandStatusInterface.ENABLED

If disabled, the value may be one of the following values which indicate why the command is disabled.

• CommandStatusInterface.MODEL_TYPE_DISABLED
• CommandStatusInterface.MODEL_STATE_DISABLED
• CommandStatusInterface.MODEL_MEMBER_DISABLED
• CommandStatusInterface.IS_CURRENT_STATE_DISABLED
• CommandStatusInterface.DISABLED

Specified by:

getCommandStatus in interface CommandStatusInterface

Parameters:

actionFilter - - the object that describes the current area.

Returns:

a indicating the status of the command.

See Also:

BaseAction.setReturnStatus(int)

setSwing

public void setSwing(boolean swing)

Sets the swing attribute which should be true when the command is used in a swing environment, false otherwise.

Parameters:

swing - the swing attribute value.

isSwing

public boolean isSwing()

Returns the swing attribute which should be true when the command is used in a swing environment, false otherwise.

Returns:

The swing attribute value.

process

protected void process(java.lang.Object o)

Processes the request object to manipulate the model. The selector then represents these changes for the user.

Overrides:

process in class BaseSelectorCommand

Parameters:

o - ignored in this implementation

setPanelVisible

public void setPanelVisible(boolean visible)

Indicates if the OLAPTimeBasedFilterSelectorPanel should or should not be displayed

Parameters:

visible - true if the OLAPTimeBasedFilterSelectorPanel should be displayed, false otherwise

getPeriodType

public java.lang.String getPeriodType()

setPeriodType

public void setPeriodType(java.lang.String value)

getNumberOfPeriods

public java.lang.String getNumberOfPeriods()

setNumberOfPeriods

public void setNumberOfPeriods(java.lang.String value)

getSelectOption

public java.lang.String getSelectOption()

setSelectOption

public void setSelectOption(java.lang.String value)

getStartingPeriodOption

public java.lang.String getStartingPeriodOption()

setStartingPeriodOption

public void setStartingPeriodOption(java.lang.String value)

getEndingPeriodOption

public java.lang.String getEndingPeriodOption()

setEndingPeriodOption

public void setEndingPeriodOption(java.lang.String value)

getSelectedPeriods

public java.lang.String[] getSelectedPeriods()

setSelectedPeriods

public void setSelectedPeriods(java.lang.String[] values)

getShowOption

public java.lang.String getShowOption()

setShowOption

public void setShowOption(java.lang.String value)

getSelectedStartingPeriod

public java.lang.String getSelectedStartingPeriod()

setSelectedStartingPeriod

public void setSelectedStartingPeriod(java.lang.String value)

getSelectedEndingPeriod

public java.lang.String getSelectedEndingPeriod()

setSelectedEndingPeriod

public void setSelectedEndingPeriod(java.lang.String value)

setRemoteAction

public void setRemoteAction(java.lang.String value)

getRemoteAction

public java.lang.String getRemoteAction()