IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.scheduler
Interface BeanTaskInfo

All Superinterfaces:
java.io.Serializable, TaskInfo, TaskStatus

public interface BeanTaskInfo
extends TaskInfo

Used to create a scheduled task which executes a TaskHandler bean. The EJB must use the TaskHandlerHome home interface and TaskHandler remote interface. The task is created using the Scheduler.create methods. When the scheduler fires the scheduled task that was created with this BeanTaskInfo, the EJB is created using the home and the process method is executed.

To control how this task is executed once it is created within a Scheduler, use the set methods on the TaskInfo interface.

Since:
5.0
Version:
5.0
See Also:
TaskInfo, Scheduler, TaskHandler, TaskHandlerHome

Field Summary
 
Fields inherited from interface com.ibm.websphere.scheduler.TaskInfo
EXECUTION_DELAYEDUPDATE, QOS_ATLEASTONCE, QOS_ONLYONCE
 
Fields inherited from interface com.ibm.websphere.scheduler.TaskStatus
CANCELLED, COMPLETE, INVALID, RUNNING, SCHEDULED, serialVersionUID, SUSPENDED
 
Method Summary
 TaskHandlerHome getTaskHandler()
          Retrieves the Home that was set with setTaskHandler or with a constructor.
 java.lang.String getTaskHandlerJNDIName()
          Gets the JNDI name of a TaskHandler EJB Home that was set using the setTaskHandler(String taskHandlerHomeJNDIName) method.
 void setTaskHandler(java.lang.String taskHandlerHomeJNDIName)
          Sets the JNDI name of a TaskHandler EJB Home that will be used to process the scheduled task.
 void setTaskHandler(TaskHandlerHome home)
          Sets the Home of the TaskHandler EJB that will be used to process the scheduled task.
 
Methods inherited from interface com.ibm.websphere.scheduler.TaskInfo
getAuthenticationAlias, getAutoPurge, getExpectedDuration, getName, getNotificationSink, getNotificationSinkJNDIName, getNumberOfRepeats, getQOS, getRepeatInterval, getStartByInterval, getStartTime, getStartTimeInterval, getTaskExecutionOptions, getUserCalendarJNDIName, getUserCalendarSpecifier, setAuthenticationAlias, setAutoPurge, setExpectedDuration, setInitialState, setName, setNotificationSink, setNotificationSink, setNotificationSink, setNotificationSink, setNumberOfRepeats, setQOS, setRepeatInterval, setStartByInterval, setStartTime, setStartTimeInterval, setTaskExecutionOptions, setUserCalendar, validate
 
Methods inherited from interface com.ibm.websphere.scheduler.TaskStatus
getNextFireTime, getRepeatsLeft, getStatus, getTaskId, getTimeCreated
 

Method Detail

setTaskHandler

void setTaskHandler(TaskHandlerHome home)
                    throws java.rmi.RemoteException
Sets the Home of the TaskHandler EJB that will be used to process the scheduled task.

Parameters:
home - the Home of the TaskHandler EJB that will be used to process the scheduled task.
Throws:
RemoteException - thrown when the Home object is invalid.
Since:
5.0
See Also:
TaskHandler, TaskHandlerHome

setTaskHandler

void setTaskHandler(java.lang.String taskHandlerHomeJNDIName)
Sets the JNDI name of a TaskHandler EJB Home that will be used to process the scheduled task.

Parameters:
taskHandlerHomeJNDIName - the fully-qualified JNDI name of the TaskHandler EJB that will be used to process the scheduled task.
Since:
6.0
See Also:
TaskHandler, TaskHandlerHome

getTaskHandler

TaskHandlerHome getTaskHandler()
                               throws java.rmi.RemoteException
Retrieves the Home that was set with setTaskHandler or with a constructor.

Returns:
the Home of the TaskHandler EJB that will be used to process the scheduled task.
Throws:
RemoteException - thrown when the Home object is invalid.
Since:
5.0

getTaskHandlerJNDIName

java.lang.String getTaskHandlerJNDIName()
Gets the JNDI name of a TaskHandler EJB Home that was set using the setTaskHandler(String taskHandlerHomeJNDIName) method.

Returns:
The JNDI name or null if the JNDI name was not set.
Since:
6.0
See Also:
TaskHandler, TaskHandlerHome

IBM WebSphere Application ServerTM
Release 8