com.ibm.commerce.scheduler.beans
Class SchedulerCommandsDataBean

java.lang.Object
  |
  +--com.ibm.commerce.beans.InputDataBeanImpl
        |
        +--com.ibm.commerce.beans.SmartDataBeanImpl
              |
              +--com.ibm.commerce.scheduler.beans.SchedulerCommandsDataBean
All Implemented Interfaces:
DataBean, InputDataBean, SchedulerDataBean, java.io.Serializable, SmartDataBean

public class SchedulerCommandsDataBean
extends SmartDataBeanImpl
implements SchedulerDataBean

A data bean that represents the scheduler commands that can be specified for a store. Along with the scheduler command, the available check commands for each command is included.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          The IBM Copyright Statement.
 
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
commandContext
 
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl
requestProperties
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
SchedulerCommandsDataBean()
           
 
Method Summary
 java.util.Vector getCheckCommandInfo(int index)
          Returns a vector of check commands that is associated with the given scheduler command.
 java.lang.String getSchedulerCommand(int index)
          Returns the name of the scheduler command.
 void populate()
          Retrieves all the scheduler commands that are specified in the SCHCMD table and retrieve the related check commands for each scheduler command.
 void setSchedulerCommand(java.lang.String newPathInfo)
          Specifies the scheduler command to retrieve.
 int size()
          Returns the number of scheduler commands that may be defined for a store.
 
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
fulfills, getCommandContext, getResources, setCommandContext
 
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl
getRequestProperties, setRequestProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.beans. InputDataBean
getRequestProperties, setRequestProperties
 
Methods inherited from interface com.ibm.commerce.beans. SmartDataBean
getCommandContext, setCommandContext
 

Field Detail
public static final java.lang.String COPYRIGHT
The IBM Copyright Statement.
See Also:
Constant Field Values
Constructor Detail

SchedulerCommandsDataBean

public SchedulerCommandsDataBean()
Method Detail

getCheckCommandInfo

public java.util.Vector getCheckCommandInfo(int index)
Returns a vector of check commands that is associated with the given scheduler command.
Parameters:
index - the index of the scheduler command.
Returns:
A list of associated check commands for the scheduler command.

getSchedulerCommand

public java.lang.String getSchedulerCommand(int index)
Returns the name of the scheduler command.
Parameters:
index - the index of the scheduler command.
Returns:
the name of the scheduler command.

populate

public void populate()
              throws java.lang.Exception
Retrieves all the scheduler commands that are specified in the SCHCMD table and retrieve the related check commands for each scheduler command. If no scheduler command was specified then all the scheduler commands will be retrieve. If the scheduler command was specified, then only the scheduler command specified will be retrieved.
Specified by:
populate in interface SmartDataBean
Overrides:
populate in class SmartDataBeanImpl
Throws:
java.lang.Exception - if there is any problem retrieving the scheduler command or their related check commands.

setSchedulerCommand

public void setSchedulerCommand(java.lang.String newPathInfo)
Specifies the scheduler command to retrieve.
Parameters:
newPathInfo - the name of the scheduler command.

size

public int size()
Returns the number of scheduler commands that may be defined for a store.
Returns:
the number of scheduler commands.