java.lang.Object | +--com.ibm.commerce.beans.InputDataBeanImpl | +--com.ibm.commerce.beans.SmartDataBeanImpl | +--com.ibm.commerce.scheduler.beans.SchedulerStatusDataBean
A data bean that represents the status of different runs for scheduled jobs. The status includes entries when the job will be run and entries of past runs of jobs.
Field Summary | |
---|---|
static java.lang.String |
_ACTUAL_END The job actual end time key for specifying the sorting of the status records. |
static java.lang.String |
_ACTUAL_START The job actual start time key for specifying the sorting of the status records. |
static java.lang.String |
_APPTYPE The job application type key for specifying the sorting of the status records. |
static java.lang.String |
_JOBREFNUM The job reference key for specifying the sorting of the status records. |
static java.lang.String |
_PATHINFO The job command key for specifying the sorting of the status records. |
static java.lang.String |
_PREFER_START The job preferred start time key for specifying the sorting of the status records. |
static java.lang.String |
_QUERY The job parameter key for specifying the sorting of the status records. |
static java.lang.String |
_STATE The job state key for specifying the sorting of the status records. |
static java.lang.String |
_STATUS The job status key for specifying the sorting of the status records. |
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 | |
---|---|
SchedulerStatusDataBean() Creates the Scheduler Status Data Bean. |
Method Summary | |
---|---|
static java.sql.Timestamp |
convertTime(java.lang.String time) Convert the input time value to a Timestamp. |
java.sql.Timestamp |
defaultStartDateCriteria() Returns the default start time that is the 0:00 of the current day. |
java.lang.String |
getActualStart(int index) Returns the actual start time for the scheduled job status for the specified index. |
java.lang.String |
getApplicationType(int index) Returns the application of the job for the specified status entry. |
java.sql.Timestamp |
getCriteriaEnd() Returns the end time used for filtering the scheduled job status. |
java.sql.Timestamp |
getCriteriaStart() Returns the start time used for filtering the scheduled job status. |
java.lang.String |
getEnd(int index) Returns the time when the status of the job has completed. |
java.lang.String |
getJobReferenceNumber(int index) Returns the job reference number for the job status. |
java.lang.String |
getOrderBy() Returns the order by attribute which the status results are sorted by. |
java.lang.String |
getPathInfo(int index) Returns the command that will be or was executed for the job status. |
java.lang.String |
getPreferedStart(int index) The preferred start time of the particular run of the job. |
java.lang.String |
getQueryString(int index) The parameters when executing the job. |
java.lang.String |
getStart(int index) Returns the start time of the status entry. |
java.lang.String |
getState(int index) Returns the state of the status entry. |
java.lang.String |
getStatus(int index) Returns the status of the jobs status entry. |
void |
populate() Retrieves status entries for the scheduled jobs that match the specified store id and fall between the start and end time. |
boolean |
setCriteriaEnd(java.lang.String dateCriteria) Sets the end time criteria used for fetching the scheduled job history of jobs. |
boolean |
setCriteriaStart(java.lang.String dateCriteria) Sets the start time criteria used for fetching the scheduled job history of jobs. |
void |
setOrderBy(java.lang.String sortField) Sets the order by attribute when returning the status of the scheduled jobs. |
void |
setStoreId(java.lang.Integer newStoreId) Sets the store id of the scheduled jobs status to retrieve. |
int |
size() Returns the number of status entries returned for the scheduled jobs. |
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
public static final java.lang.String _JOBREFNUM
public static final java.lang.String _PATHINFO
public static final java.lang.String _QUERY
public static final java.lang.String _APPTYPE
public static final java.lang.String _STATUS
public static final java.lang.String _STATE
public static final java.lang.String _PREFER_START
public static final java.lang.String _ACTUAL_START
public static final java.lang.String _ACTUAL_END
Constructor Detail |
---|
public SchedulerStatusDataBean()
Method Detail |
---|
public static final java.sql.Timestamp convertTime(java.lang.String time) throws ECException
time
- the time to comvert to a timestamp object.ECException
- if there are any problems converting the given time.public java.sql.Timestamp defaultStartDateCriteria()
public java.lang.String getActualStart(int index)
public java.lang.String getApplicationType(int index)
public java.sql.Timestamp getCriteriaEnd()
public java.sql.Timestamp getCriteriaStart()
public java.lang.String getEnd(int index)
public java.lang.String getJobReferenceNumber(int index)
public java.lang.String getOrderBy()
public java.lang.String getPathInfo(int index)
public java.lang.String getPreferedStart(int index)
public java.lang.String getQueryString(int index)
public java.lang.String getStart(int index)
public java.lang.String getState(int index)
public java.lang.String getStatus(int index)
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 setOrderBy(java.lang.String sortField)
sortField
- the attribute the status records will be sorted
by.public void setStoreId(java.lang.Integer newStoreId)
newStoreId
- the store id of the store.public int size()
public boolean setCriteriaEnd(java.lang.String dateCriteria)
public boolean setCriteriaStart(java.lang.String dateCriteria)