java.lang.Object | +--com.ibm.commerce.beans.InputDataBeanImpl | +--com.ibm.commerce.beans.SmartDataBeanImpl | +--com.ibm.commerce.scheduler.beans.SchedulerItemsDataBean
A Data Bean that represents a list of Scheduled Jobs.
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
Constructor Detail |
---|
public SchedulerItemsDataBean()
Method Detail |
---|
public java.lang.String getActiveFlag(int index)
index
- the position of the scheduled job.public java.lang.String getApplicationType(int index)
index
- the position of the scheduled job.public java.lang.String getAttempts(int index)
index
- the position of the scheduled job.public java.lang.String getDelay(int index)
index
- the position of the scheduled job.public java.lang.String getHost(int index)
index
- the position of the scheduled job.public java.lang.String getInterfaceName(int index)
index
- the position of the scheduled job.public java.lang.String getInterval(int index)
index
- the position of the scheduled job.public java.lang.String getJobRefNum(int index)
index
- the position of the scheduled job.public java.lang.String getPathInfo(int index)
index
- the position of the scheduled job.public java.lang.String getPriority(int index)
index
- the position of the scheduled job.public java.lang.String getQueryString(int index)
index
- the position of the scheduled job.public java.lang.String getSequence(int index)
index
- the position of the scheduled job.public java.lang.String getStart(int index)
index
- the position of the scheduled job.public java.lang.String getStoreId(int index)
index
- the position of the scheduled job.public java.lang.String getUserReferenceNumber(int index)
index
- the position of the scheduled job.public void populate() throws java.lang.Exception
populate
in interface
SmartDataBean
populate
in class
SmartDataBeanImpl
java.lang.Exception
- if there are any problems retrieving the
data.public void setJobRefNum(java.lang.String newJobRefNum)
newJobRefNum
- the job reference number.public void setOrderBy(java.lang.String orderBy)
orderBy
- the property to sort the scheduled jobs
by.public int size()