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, SmartDataBean, SchedulerDataBean, java.io.Serializable

public class SchedulerCommandsDataBean
extends SmartDataBeanImpl
implements SchedulerDataBean

This class defines 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 are included.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM Copyright Statement.

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
SchedulerCommandsDataBean()

Method Summary

Modifier and Type	Method and Description
java.util.Vector	getCheckCommandInfo(int index) This method gets a Vector of check commands that is associated with the given scheduler command.
java.lang.String	getSchedulerCommand(int index) This method gets the name of the scheduler command.
void	populate() This method retrieves all the scheduler commands that are specified in the SCHCMD table.
void	setSchedulerCommand(java.lang.String newPathInfo) This method specifies the scheduler command to retrieve.
int	size() This method gets the number of scheduler commands that may be defined for a store.

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

getRequestProperties, setRequestProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.beans.SmartDataBean

getCommandContext, setCommandContext

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

getRequestProperties, setRequestProperties

Field Detail

COPYRIGHT

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)

This method gets a Vector of check commands that is associated with the given scheduler command.

Parameters:

index - This is the index of the scheduler command.

Returns:

This method returns a Vector that represents the list of associated check commands for the scheduler command.

getSchedulerCommand

public java.lang.String getSchedulerCommand(int index)

This method gets the name of the scheduler command.

Parameters:

index - This is the index of the scheduler command.

Returns:

This method returns a String that represents the name of the scheduler command.

populate

public void populate()
              throws java.lang.Exception

This method retrieves all the scheduler commands that are specified in the SCHCMD table. It also retrieves the related check commands for each scheduler command. If no scheduler command was specified then all the scheduler commands will be retrieved. 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 - This is thrown if there are any problems retrieving the scheduler command or its related check commands.

setSchedulerCommand

public void setSchedulerCommand(java.lang.String newPathInfo)

This method specifies the scheduler command to retrieve.

Parameters:

newPathInfo - This is the name of the scheduler command.

size

public int size()

This method gets the number of scheduler commands that may be defined for a store.

Returns:

This method returns an int value that represents the number of scheduler commands.