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, SmartDataBean, SchedulerDataBean, java.io.Serializable
```
public class SchedulerItemsDataBean
extends SmartDataBeanImpl
implements SchedulerDataBean
```
A data bean that represents a list of Scheduled Jobs.

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

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

Constructor Summary

Constructors
Constructor and Description

SchedulerItemsDataBean()
Creates the Scheduler Item Data Bean.

Constructors
Constructor and Description
`SchedulerItemsDataBean()` Creates the Scheduler Item Data Bean.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getActiveFlag()` Returns the Active Flag for the specified scheduled job.
`java.lang.String`	`getActiveFlag(int index)` Returns the Active Flag for the specified scheduled job.
`java.lang.String`	`getApplicationType()` Returns the application type for the 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`	`getDescription()` Returns the description for the specified scheduled job.
`java.lang.String`	`getDescription(int index)` Returns the description for the specified scheduled job.
`java.lang.String`	`getFirstApplicationType()` Returns the application type for the scheduled job.
`java.lang.String`	`getFirstFormattedStart()` Returns the last start time for the last run of the specified scheduled job.
`java.lang.String`	`getFirstHost()` Returns the scheduler instance (often referred to as host name) of the specified scheduled job.
`java.lang.String`	`getFirstInterval()` Returns the interval in seconds when to run the specified scheduled job next.
`java.lang.String`	`getFirstJobRefNum()` Returns the job reference number for the specified scheduled job.
`java.lang.String`	`getFirstPathInfo()` Returns the command that will be executed for the scheduled job.
`java.lang.String`	`getFirstQueryString()` The parameters that will be passed to the specified scheduled job.
`java.lang.String`	`getFirstStoreId()` Returns the store id for the store that the specified scheduled job will run for.
`java.lang.String`	`getFirstUserReferenceNumber()` Returns the user identity for the running the specified scheduled job.
`java.lang.String`	`getFormattedStart()` Returns the last start time for the last run of the specified scheduled job.
`java.lang.String`	`getHost()` Returns the scheduler instance (often referred to as host name) of the specified scheduled job.
`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()` Returns the interface that represents the check command for 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()` Returns the interval in seconds when to run the specified scheduled job next.
`java.lang.String`	`getInterval(int index)` Returns the interval in seconds when to run the specified scheduled job next.
`java.lang.String`	`getJobRefNum()` Returns the job reference number for the specified scheduled job.
`java.lang.String`	`getJobRefNum(int index)` Returns the job reference number for the specified scheduled job.
`java.lang.String`	`getPathInfo()` Returns the command that will be executed for the scheduled job.
`java.lang.String`	`getPathInfo(int index)` Returns the command that will be executed for the scheduled job.
`java.lang.String`	`getPriority()` Returns the priority for running the specified scheduled job.
`java.lang.String`	`getPriority(int index)` Returns the priority for running the specified scheduled job.
`java.lang.String`	`getQueryString()` The parameters that will be passed to 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()` Returns the sequence for the specified scheduled job.
`java.lang.String`	`getSequence(int index)` Returns the sequence for the specified scheduled job.
`java.lang.String`	`getStart()` Returns the last start time for the last run of 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()` Returns the store id for the store that the specified scheduled job will run for.
`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()` Returns the user identity for the running the specified scheduled job.
`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 scheduled 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, 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
  - SchedulerItemsDataBean
```
public SchedulerItemsDataBean()
```
    Creates the Scheduler Item Data Bean.
- Method Detail
  - getActiveFlag
```
public java.lang.String getActiveFlag()
```
    Returns the Active Flag for the specified scheduled job.
    
    Returns:
    
    the active flag for the job.
  - 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()
```
    Returns the application type for the scheduled job.
    
    Returns:
    
    the application type for the job.
  - getFirstApplicationType
```
public java.lang.String getFirstApplicationType()
```
    Returns the application type for the scheduled job.
    
    Returns:
    
    the application type 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()
```
    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.
    
    Returns:
    
    The scheduler instance to run the job.
  - getFirstHost
```
public java.lang.String getFirstHost()
```
    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.
    
    Returns:
    
    The scheduler instance to run 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.
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description for the specified scheduled job.
    
    Returns:
    
    the interface of the check command for the job.
  - getDescription
```
public java.lang.String getDescription(int index)
```
    Returns the description for the specified scheduled job.
    
    Returns:
    
    the interface of the check command for the job.
  - getInterfaceName
```
public java.lang.String getInterfaceName()
```
    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.
    
    Returns:
    
    the interface of the check command for 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()
```
    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 than 0 is the number of seconds to wait before reexecuting the job.
    
    Returns:
    
    the interval when the job needs to run next.
  - getFirstInterval
```
public java.lang.String getFirstInterval()
```
    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 than 0 is the number of seconds to wait before reexecuting the job.
    
    Returns:
    
    the interval when the job needs to run next.
  - 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 than 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()
```
    Returns the job reference number for the specified scheduled job.
    
    Returns:
    
    the job reference number of the job.
  - getFirstJobRefNum
```
public java.lang.String getFirstJobRefNum()
```
    Returns the job reference number for the specified scheduled job.
    
    Returns:
    
    the job reference number of the job.
  - 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()
```
    Returns the command that will be executed for the scheduled job.
    
    Returns:
    
    the command of the job.
  - getFirstPathInfo
```
public java.lang.String getFirstPathInfo()
```
    Returns the command that will be executed for the scheduled job.
    
    Returns:
    
    the command 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()
```
    Returns the priority for running the specified scheduled job.
    
    Parameters:
    
    index - the position of the scheduled job.
    
    Returns:
    
    the priority 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()
```
    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.
  - getFirstQueryString
```
public java.lang.String getFirstQueryString()
```
    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.
  - 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()
```
    Returns the sequence for the specified scheduled job.
    
    Returns:
    
    the sequence of 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.
  - getFirstFormattedStart
```
public java.lang.String getFirstFormattedStart()
```
    Returns the last start time for the last run of the specified scheduled job. The start time is formatted according to the current locale
    
    Returns:
    
    the start time of the job.
  - getFormattedStart
```
public java.lang.String getFormattedStart()
```
    Returns the last start time for the last run of the specified scheduled job. The start time is formatted according to the current locale
    
    Returns:
    
    the start time of the job.
  - getStart
```
public java.lang.String getStart()
```
    Returns the last start time for the last run of the specified scheduled job.
    
    Returns:
    
    the start time 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()
```
    Returns the store id for the store that the specified scheduled job will run for.
    
    Returns:
    
    the store id of the job.
  - getFirstStoreId
```
public java.lang.String getFirstStoreId()
```
    Returns the store id for the store that the specified scheduled job will run for.
    
    Returns:
    
    the store id 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()
```
    Returns the user identity for the running the specified scheduled job.
    
    Returns:
    
    The user identity of the scheduled job.
  - getFirstUserReferenceNumber
```
public java.lang.String getFirstUserReferenceNumber()
```
    Returns the user identity for the running the specified scheduled job.
    
    Returns:
    
    The user identity of the scheduled 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 identity 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 scheduled 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.

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

SchedulerItemsDataBean

getActiveFlag

getActiveFlag

getApplicationType

getFirstApplicationType

getApplicationType

getAttempts

getDelay

getHost

getFirstHost

getHost

getDescription

getDescription

getInterfaceName

getInterfaceName

getInterval

getFirstInterval

getInterval

getJobRefNum

getFirstJobRefNum

getJobRefNum

getPathInfo

getFirstPathInfo

getPathInfo

getPriority

getPriority

getQueryString

getFirstQueryString

getQueryString

getSequence

getSequence

getFirstFormattedStart

getFormattedStart

getStart

getStart

getStoreId

getFirstStoreId

getStoreId

getUserReferenceNumber

getFirstUserReferenceNumber

getUserReferenceNumber

populate

setJobRefNum

setOrderBy

size