SchedulerStatusDataBean

java.lang.Object
- com.ibm.commerce.beans.InputDataBeanImpl
- - com.ibm.commerce.beans.SmartDataBeanImpl
  - - com.ibm.commerce.scheduler.beans.SchedulerStatusDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, SchedulerDataBean, java.io.Serializable
```
public class SchedulerStatusDataBean
extends SmartDataBeanImpl
implements SchedulerDataBean
```
This class defines a data bean that represents the status of different runs of scheduled jobs. The status includes entries of when the job will be run and entries of past job runs.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`_ACTUAL_END` This is the job actual end time key for specifying the sorting of the status records.
`static java.lang.String`	`_ACTUAL_START` This is the job actual start time key for specifying the sorting of the status records.
`static java.lang.String`	`_APPTYPE` This is the job application type key for specifying the sorting of the status records.
`static java.lang.String`	`_JOBREFNUM` This is the job reference key for specifying the sorting of the status records.
`static java.lang.String`	`_PATHINFO` This is the job command key for specifying the sorting of the status records.
`static java.lang.String`	`_PREFER_START` This is the job preferred start time key for specifying the sorting of the status records.
`static java.lang.String`	`_QUERY` This is the job parameter key for specifying the sorting of the status records.
`static java.lang.String`	`_STATE` This is the job state key for specifying the sorting of the status records.
`static java.lang.String`	`_STATUS` This is the job status key for specifying the sorting of the status records.
`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

SchedulerStatusDataBean()
This is the default constructor for this class.

Constructors
Constructor and Description
`SchedulerStatusDataBean()` This is the default constructor for this class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.sql.Timestamp`	`convertTime(java.lang.String time)` This method converts the input time value to a `Timestamp` object.
`java.sql.Timestamp`	`defaultStartDateCriteria()` This method gets the default start time.
`java.lang.String`	`getActualStart(int index)` This method gets the actual start time for the scheduled job status for the specified index.
`java.lang.String`	`getApplicationType(int index)` This method gets the application of the job for the specified status entry.
`java.sql.Timestamp`	`getCriteriaEnd()` This method gets the end time used for filtering the scheduled job status.
`java.sql.Timestamp`	`getCriteriaStart()` This method gets the start time used for filtering the scheduled job status.
`java.lang.String`	`getEnd(int index)` This method gets the time when the job was completed.
`java.lang.String`	`getJobReferenceNumber(int index)` This method gets the job reference number for the job status.
`java.lang.Long`	`getMaxItems()` Gets the maximum number scheduled status records to be retrieved by this class.
`java.lang.String`	`getOrderBy()` This method gets the `ORDERBY` attribute.
`java.lang.String`	`getPathInfo(int index)` This method gets the command that will be or was executed for the job status.
`java.lang.String`	`getPreferedStart(int index)` This method gets the preferred start time of the particular run of the job.
`java.lang.String`	`getQueryString(int index)` This method gets the parameters when executing the job.
`java.lang.String`	`getStart(int index)` This method gets the start time of the status entry.
`java.lang.String`	`getState(int index)` This method gets the state of the status entry.
`java.lang.String`	`getStatus(int index)` This method gets the status of the jobs status entry.
`boolean`	`hasMoreItems()` Indicates that the maximum number of records has been reached.
`void`	`populate()` This method retrieves the 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)` This method sets the end time criteria used for fetching the scheduled job history of jobs.
`boolean`	`setCriteriaStart(java.lang.String dateCriteria)` This method sets the start time criteria used for fetching the scheduled job history of jobs.
`void`	`setMaxItems(java.lang.Long maxNumOfItems)` Sets the maximum number scheduled status records to be retrieved.
`void`	`setOrderBy(java.lang.String sortField)` This method sets the `ORDERBY` attribute when returning the status of the scheduled jobs.
`void`	`setStoreId(java.lang.Integer newStoreId)` This method sets the store id of the scheduled job status.
`int`	`size()` This method gets the number of status entries returned for the scheduled jobs.

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
  - _JOBREFNUM
```
public static final java.lang.String _JOBREFNUM
```
    This is the job reference key for specifying the sorting of the status records.
    
    See Also:
    
    Constant Field Values
  - _PATHINFO
```
public static final java.lang.String _PATHINFO
```
    This is the job command key for specifying the sorting of the status records.
    
    See Also:
    
    Constant Field Values
  - _QUERY
```
public static final java.lang.String _QUERY
```
    This is the job parameter key for specifying the sorting of the status records.
    
    See Also:
    
    Constant Field Values
  - _APPTYPE
```
public static final java.lang.String _APPTYPE
```
    This is the job application type key for specifying the sorting of the status records.
    
    See Also:
    
    Constant Field Values
  - _STATUS
```
public static final java.lang.String _STATUS
```
    This is the job status key for specifying the sorting of the status records.
    
    See Also:
    
    Constant Field Values
  - _STATE
```
public static final java.lang.String _STATE
```
    This is the job state key for specifying the sorting of the status records.
    
    See Also:
    
    Constant Field Values
  - _PREFER_START
```
public static final java.lang.String _PREFER_START
```
    This is the job preferred start time key for specifying the sorting of the status records.
    
    See Also:
    
    Constant Field Values
  - _ACTUAL_START
```
public static final java.lang.String _ACTUAL_START
```
    This is the job actual start time key for specifying the sorting of the status records.
    
    See Also:
    
    Constant Field Values
  - _ACTUAL_END
```
public static final java.lang.String _ACTUAL_END
```
    This is the job actual end time key for specifying the sorting of the status records.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SchedulerStatusDataBean
```
public SchedulerStatusDataBean()
```
    This is the default constructor for this class. It calls the constructor from the superclass.
- Method Detail
  - convertTime
```
public static final java.sql.Timestamp convertTime(java.lang.String time)
                                            throws ECException
```
    This method converts the input time value to a Timestamp object.
    
    Parameters:
    
    time - This is a String object that represents the time to be converted to a Timestamp object.
    
    Returns:
    
    This method returns a Timestamp object that represents the given String.
    
    Throws:
    
    ECException - This is thrown if there are any problems converting the given time.
  - defaultStartDateCriteria
```
public java.sql.Timestamp defaultStartDateCriteria()
```
    This method gets the default start time. The default start time will be 0:00 on the current day.
    
    Returns:
    
    This method returns a Timestamp object that represents the default start time.
  - getActualStart
```
public java.lang.String getActualStart(int index)
```
    This method gets the actual start time for the scheduled job status for the specified index.
    
    Parameters:
    
    index - This is the position of the status to return.
    
    Returns:
    
    This method returns a String object that represents the actual start time of the status entry.
  - getApplicationType
```
public java.lang.String getApplicationType(int index)
```
    This method gets the application of the job for the specified status entry.
    
    Parameters:
    
    index - This is the position of the status to return.
    
    Returns:
    
    This method returns a String object that represents the application type of the job for the status entry.
  - getCriteriaEnd
```
public java.sql.Timestamp getCriteriaEnd()
```
    This method gets the end time used for filtering the scheduled job status.
    
    Returns:
    
    This method returns a Timestamp object that represents the end time criteria.
  - getCriteriaStart
```
public java.sql.Timestamp getCriteriaStart()
```
    This method gets the start time used for filtering the scheduled job status.
    
    Returns:
    
    This method returns a Timestamp object that represents the start time criteria.
  - getEnd
```
public java.lang.String getEnd(int index)
```
    This method gets the time when the job was completed. A status value of null or an empty string means that the job has not completed running.
    
    Parameters:
    
    index - This is the position of the status to return.
    
    Returns:
    
    This method returns a String object that represents the end time of the job status.
  - getJobReferenceNumber
```
public java.lang.String getJobReferenceNumber(int index)
```
    This method gets the job reference number for the job status.
    
    Parameters:
    
    index - This is the position of the status to return.
    
    Returns:
    
    This method returns a String object that represents the job reference number of the job status.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    This method gets the ORDERBY attribute. The status results are sorted by this attribute.
    
    Returns:
    
    This method returns a String object that represents the ORDERBY status attribute.
  - getPathInfo
```
public java.lang.String getPathInfo(int index)
```
    This method gets the command that will be or was executed for the job status.
    
    Parameters:
    
    index - This is the position of the status to return.
    
    Returns:
    
    This method returns a String object that represents the command to execute.
  - getPreferedStart
```
public java.lang.String getPreferedStart(int index)
```
    This method gets the preferred start time of the particular run of the job.
    
    Parameters:
    
    index - This is the position of the status to return.
    
    Returns:
    
    This method returns a String object that represents the preferred start time of the job's status.
  - getQueryString
```
public java.lang.String getQueryString(int index)
```
    This method gets the parameters when executing the job.
    
    Parameters:
    
    index - This is the position of the status to return.
    
    Returns:
    
    This method returns a String object that represents the parameters of the job.
  - getStart
```
public java.lang.String getStart(int index)
```
    This method gets the start time of the status entry.
    
    Parameters:
    
    index - The position of the status to return.
    
    Returns:
    
    This method returns a String object that represents the start time of the status entry.
  - getState
```
public java.lang.String getState(int index)
```
    This method gets the state of the status entry.
    
    Parameters:
    
    index - This is the position of the status to return.
    
    Returns:
    
    This method returns a String object that represents the state of the status entry.
  - getStatus
```
public java.lang.String getStatus(int index)
```
    This method gets the status of the jobs status entry.
    
    Parameters:
    
    index - This is the position of the status to return.
    
    Returns:
    
    This method returns a String object that represents the status of the job status entry.
  - populate
```
public void populate()
              throws java.lang.Exception
```
    This method retrieves the status entries for the scheduled jobs that match the specified store id and fall between the start and end time.
    
    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 data.
  - setOrderBy
```
public void setOrderBy(java.lang.String sortField)
```
    This method sets the ORDERBY attribute when returning the status of the scheduled jobs. The default is ORDERBY attribute is _ACTUAL_START.
    
    Parameters:
    
    sortField - This is the attribute by which the status records will be sorted.
  - setStoreId
```
public void setStoreId(java.lang.Integer newStoreId)
```
    This method sets the store id of the scheduled job status.
    
    Parameters:
    
    newStoreId - This is the store id of the store.
  - size
```
public int size()
```
    This method gets the number of status entries returned for the scheduled jobs.
    
    Returns:
    
    This method returns an int value that represents the number of status records found for the given time criteria.
  - setCriteriaEnd
```
public boolean setCriteriaEnd(java.lang.String dateCriteria)
```
    This method sets the end time criteria used for fetching the scheduled job history of jobs.
    
    Parameters:
    
    dateCriteria - This is the time used for the ending point of the job's status records.
    
    Returns:
    
    This method returns a boolean value that indicates whether the specified String can be converted into a valid Timestamp object.
  - setCriteriaStart
```
public boolean setCriteriaStart(java.lang.String dateCriteria)
```
    This method sets the start time criteria used for fetching the scheduled job history of jobs.
    
    Parameters:
    
    dateCriteria - This is the time used for the starting point of the job's status records.
    
    Returns:
    
    This method returns a boolean value that indicates whether the specified String can be converted into a valid Timestamp object.
  - setMaxItems
```
public void setMaxItems(java.lang.Long maxNumOfItems)
```
    Sets the maximum number scheduled status records to be retrieved.
    
    Parameters:
    
    maxNumOfItems - The maximum number scheduled status records to be retrieved.
  - getMaxItems
```
public java.lang.Long getMaxItems()
```
    Gets the maximum number scheduled status records to be retrieved by this class.
    
    Returns:
    
    The maximum number scheduled status records to be retrieved.
  - hasMoreItems
```
public boolean hasMoreItems()
```
    Indicates that the maximum number of records has been reached. There may be more items to be retrieved.
    
    Returns:
    
    true if there may be more items to be retrieved.

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

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

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

Methods inherited from class java.lang.Object

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

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

COPYRIGHT

_JOBREFNUM

_PATHINFO

_QUERY

_APPTYPE

_STATUS

_STATE

_PREFER_START

_ACTUAL_START

_ACTUAL_END

SchedulerStatusDataBean

convertTime

defaultStartDateCriteria

getActualStart

getApplicationType

getCriteriaEnd

getCriteriaStart

getEnd

getJobReferenceNumber

getOrderBy

getPathInfo

getPreferedStart

getQueryString

getStart

getState

getStatus

populate

setOrderBy

setStoreId

size

setCriteriaEnd

setCriteriaStart

setMaxItems

getMaxItems

hasMoreItems