Method | Description |
|---|---|
getParameter | protected java.lang.String getParameter(java.lang.String key) This returns the value of a configuration option for this command. |
getDefaultmeter | protected java.lang.String getDefaultParameter(java.lang.String key, java.lang.String defaultValue) |
getBooleanParameter | protected boolean getBooleanParameter(java.lang.String key, boolean defaultValue) |
getRequiredBooleanParameter | protected boolean getRequiredBooleanParameter(java.lang.String key) |
getRequiredParameter | protected java.lang.String getRequiredParameter(java.lang.String key) This returns the value of a configuration option for this command. If it does not exist, it throws a JBotException. |
getParameterSubset | protected java.util.SortedMap<java.lang.String,java.lang.String> getParameterSubset(java.lang.String prefix) This will return the parameters in alphabetical order that start with the given prefix. Parameters prefix: Prefix of the parameter to match. Returns A sorted map of parameters |
execute | public abstract void execute() throws java.lang.Exception This is the method invoked by the CommandProcessor when the command is executed. Throws java.lang.Exception |
getName | public java.lang.String getName() Returns command String key. Returns java.lang.String |
supressBusyCursor | public boolean supressBusyCursor() Return True if this command should not display the hourglass. This should only be set to true if the command is very fast. |
getEvent | public java.lang.Object getEvent() Returns original event object. It could be any swing events for example. Returns java.lang.Object |
setStatusFlag | public void setStatusFlag(java.lang.String flag, boolean status) Set the specified status flag in the DataManager. These statuses determine validation, JButtons' enabled status, etc. Parameters flag: the status value status: the boolean status |
getStatusFlag | public boolean getStatusFlag(java.lang.String flag) Get the value of the specified status flag in the DataManager. These statuses determine validation, JButtons' status, an so forth. Parameters flag: the status value Returns • True: if flag is true • False: if flag not found or flag is false. |
fireStatusChanges | public void fireStatusChanges() Notifies all interested components that the tool's statuses have changed. |
getDataStore | public IDataStore getDataStore(java.lang.String dataStoreKey) Returns the DataStore with the specified key. Parameters dataStoreKey: the String key that describes the DataStore Returns The datastore. |
getCurrentDataRow | public final IDataRow getCurrentDataRow(java.lang.String dataStore) A convenience method that will get the current datarow of a datastore. Parameters dataStore: the name of the data store. |
getJBotEvent | public JBotEvent getJBotEvent() Returns JBotEvent object. Returns com.ces.jbot.JBotEvent |
isAbort | public boolean isAbort() Indicates whether processing of additional commands in this package should be aborted. |
setAbort | protected void setAbort(boolean b) If true, instructs the command processor to not process any additional commands for this event. |
getDataSourceValue | protected java.lang.Object getDataSourceValue(java.lang.String dataSource) Returns the value of a datasource in the form of [datastore].[column name]. Parameters dataSource: the datasource Returns the value |