com.ibm.commerce.scheduler.beans
Class SchedulerItemsDataBean

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

public class SchedulerItemsDataBean
extends SmartDataBeanImpl
implements SchedulerDataBean

A Data Bean that represents a list of Scheduled Jobs.

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
SchedulerItemsDataBean()
          Creates the Scheduler Item Data Bean.
 
Method Summary
 java.lang.String getActiveFlag(int index)
          Returns the Active Flag for the specified scheduled job.
 java.lang.String getApplicationType(int index)
          Returns the application type for the scheduled job.
 java.lang.String getAttempts(int index)
          Returns the attempts of running the specified scheduled job incase of failure.
 java.lang.String getDelay(int index)
          Returns the delay in seconds before attempt to rerun the specified scheduled job in case of a failed run.
 java.lang.String getHost(int index)
          Returns the scheduler instance (often referred to as host name) of the specified scheduled job.
 java.lang.String getInterfaceName(int index)
          Returns the interface that represents the check command for the specified scheduled job.
 java.lang.String getInterval(int index)
          Returns the interval in seconds when to run the specified scheduled job next.
 java.lang.String getJobRefNum(int index)
          Returns the job reference number for the specified scheduled job.
 java.lang.String getPathInfo(int index)
          Returns the command that will be executed for the scheduled job.
 java.lang.String getPriority(int index)
          Returns the priority for running the specified scheduled job.
 java.lang.String getQueryString(int index)
          The parameters that will be passed to the specified scheduled job.
 java.lang.String getSequence(int index)
          Returns the sequence for the specified scheduled job.
 java.lang.String getStart(int index)
          Returns the last start time for the last run of the specified scheduled job.
 java.lang.String getStoreId(int index)
          Returns the store id for the store that the specified scheduled job will run for.
 java.lang.String getUserReferenceNumber(int index)
          Returns the user identity for the running the specified scheduled job.
 void populate()
          Retrieves the specified scheduled job.
 void setJobRefNum(java.lang.String newJobRefNum)
          Sets the job number for the scheuled job that should be found.
 void setOrderBy(java.lang.String orderBy)
          Indicates what property should be used to sort the list of scheduled jobs.
 int size()
          Returns the number of items for the specified job reference number.
 
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

SchedulerItemsDataBean

public SchedulerItemsDataBean()
Creates the Scheduler Item Data Bean.
Method Detail

getActiveFlag

public java.lang.String getActiveFlag(int index)
Returns the Active Flag for the specified scheduled job.
Parameters:
index - the position of the scheduled job.
Returns:
the active flag for the job.

getApplicationType

public java.lang.String getApplicationType(int index)
Returns the application type for the scheduled job.
Parameters:
index - the position of the scheduled job.
Returns:
the application type for the job.

getAttempts

public java.lang.String getAttempts(int index)
Returns the attempts of running the specified scheduled job incase of failure.
Parameters:
index - the position of the scheduled job.
Returns:
the attempts to run the job successfully.

getDelay

public java.lang.String getDelay(int index)
Returns the delay in seconds before attempt to rerun the specified scheduled job in case of a failed run.
Parameters:
index - the position of the scheduled job.
Returns:
the delay in seconds before attempting to rerun the job.

getHost

public java.lang.String getHost(int index)
Returns the scheduler instance (often referred to as host name) of the specified scheduled job. This is the particular clone instance that should run the scheduled job and is often the web server host name of the commerce instance.
Parameters:
index - the position of the scheduled job.
Returns:
The scheduler instance to run the job.

getInterfaceName

public java.lang.String getInterfaceName(int index)
Returns the interface that represents the check command for the specified scheduled job. If an empty string is returned, then the job will automatically run.
Parameters:
index - the position of the scheduled job.
Returns:
the interface of the check command for the job.

getInterval

public java.lang.String getInterval(int index)
Returns the interval in seconds when to run the specified scheduled job next. An interval value of 0 means that the job runs only once but an interval greater then 0 is the number of seconds to wait before reexecuting the job.
Parameters:
index - the position of the scheduled job.
Returns:
the interval when the job needs to run next.

getJobRefNum

public java.lang.String getJobRefNum(int index)
Returns the job reference number for the specified scheduled job.
Parameters:
index - the position of the scheduled job.
Returns:
the job reference number of the job.

getPathInfo

public java.lang.String getPathInfo(int index)
Returns the command that will be executed for the scheduled job.
Parameters:
index - the position of the scheduled job.
Returns:
the command of the job.

getPriority

public java.lang.String getPriority(int index)
Returns the priority for running the specified scheduled job.
Parameters:
index - the position of the scheduled job.
Returns:
the priority of the job.

getQueryString

public java.lang.String getQueryString(int index)
The parameters that will be passed to the specified scheduled job. The parameters will be in the same form as the query string used for HTTP GET requests.
Parameters:
index - the position of the scheduled job.
Returns:
the parameters for the job.

getSequence

public java.lang.String getSequence(int index)
Returns the sequence for the specified scheduled job.
Parameters:
index - the position of the scheduled job.
Returns:
the sequence of the job.

getStart

public java.lang.String getStart(int index)
Returns the last start time for the last run of the specified scheduled job.
Parameters:
index - the position of the scheduled job.
Returns:
the start time of the job.

getStoreId

public java.lang.String getStoreId(int index)
Returns the store id for the store that the specified scheduled job will run for.
Parameters:
index - the position of the scheduled job.
Returns:
the store id of the job.

getUserReferenceNumber

public java.lang.String getUserReferenceNumber(int index)
Returns the user identity for the running the specified scheduled job.
Parameters:
index - the position of the scheduled job.
Returns:
The user identify of the scheduled job.

populate

public void populate()
              throws java.lang.Exception
Retrieves the specified scheduled job. The start time of the job will be the last start time recorded for the job when the job last ran.
Specified by:
populate in interface SmartDataBean
Overrides:
populate in class SmartDataBeanImpl
Throws:
java.lang.Exception - if there are any problems retrieving the data.

setJobRefNum

public void setJobRefNum(java.lang.String newJobRefNum)
Sets the job number for the scheuled job that should be found.
Parameters:
newJobRefNum - the job reference number.

setOrderBy

public void setOrderBy(java.lang.String orderBy)
Indicates what property should be used to sort the list of scheduled jobs.
Parameters:
orderBy - the property to sort the scheduled jobs by.

size

public int size()
Returns the number of items for the specified job reference number.
Returns:
the number of scheduled jobs found. This should always be one.