2010-01-26 1.2.0

org.eclipse.soda.dk.epcglobal.llrp.helper.taskmanager
Interface ITask

All Known Subinterfaces:
ITaskManager
All Known Implementing Classes:
AbstractLLRPTask, AbstractSimpleTask, AbstractTask, AbstractTask_ACCESS_TAG, AbstractTask_ACCESSSPEC, AbstractTask_ROSPEC, Task_ADD_ACCESSSPEC, Task_ADD_ROSPEC, Task_Array, Task_BLOCKERASE_TAG, Task_BLOCKWRITE_TAG, Task_DELETE_ACCESSSPEC, Task_DELETE_EXIST_ACCESSSPEC, Task_DELETE_EXIST_ROSPEC, Task_DELETE_ROSPEC, Task_DISABLE_ACCESSSPEC, Task_DISABLE_ROSPEC, Task_ENABLE_ACCESSSPEC, Task_ENABLE_ROSPEC, Task_GET_ACCESSSPECS, Task_GET_GPIConfig, Task_GET_GPOConfig, Task_GET_READER_CAPABILITIES, Task_GET_ROSPECS, Task_INCREMENT_WRITE, Task_KILL_TAG, Task_LOCK_TAG, Task_READ_TAG, Task_SET_READER_CONFIG, Task_START_EXIST_ROSPEC, Task_START_ROSPEC, Task_STOP_EXIST_ROSPEC, Task_STOP_ROSPEC, Task_WRITE_TAG, TaskManager

public interface ITask

Since:
1.0
Version:
1.2.0

Field Summary
static int ABORT
          Define the abort (int) constant.
static int ERROR
          Define the error (int) constant.
static int REPORT
          Define the report (int) constant.
static int STATE_RUNNING
          Define the state running (int) constant.
static int STATE_STANDBY
          Define the state standby (int) constant.
static int SUCCESS
          Define the success (int) constant.
static int TIMEOUT
          Define the timeout (int) constant.
 
Method Summary
 void abort()
          Abort.
 void addTaskListener(ITaskListener listener)
          Add task listener with the specified listener parameter.
 boolean duplicateTask(ITask task)
          Duplicate task with the specified task parameter and return the boolean result.
 ITaskManager getTaskManager()
          Gets the task manager (ITaskManager) value.
 java.lang.String getTaskName()
          Gets the task name (String) value.
 java.lang.Object getTaskOwner()
          Gets the task owner (Object) value.
 void handleResponse(SignalService source, java.lang.Object timestamp, java.lang.Object data)
          Finished with the specified source, timestamp and data parameters and return the boolean result.
 boolean isResponseExpected(SignalService source, java.lang.Object timestamp, java.lang.Object data)
          Is response expected with the specified source, timestamp and data parameters and return the boolean result.
 boolean launchTask()
          Launch task and return the boolean result.
 void notifyListener(java.lang.String taskName, int status, java.lang.Object result)
          Notify listener with the specified finished and result parameters.
 void removeTaskListener(ITaskListener listener)
          Remove task listener with the specified listener parameter.
 void reset()
          Reset.
 void setTaskManager(ITaskManager taskManager)
          Sets the task manager value.
 void setTaskOwner(java.lang.Object taskOwner)
          Sets the task owner value.
 void start()
          Start.
 void start(ITaskManager taskManager)
          Start with the specified task manager parameter.
 

Field Detail

ERROR

static final int ERROR
Define the error (int) constant.

See Also:
Constant Field Values

SUCCESS

static final int SUCCESS
Define the success (int) constant.

See Also:
Constant Field Values

TIMEOUT

static final int TIMEOUT
Define the timeout (int) constant.

See Also:
Constant Field Values

REPORT

static final int REPORT
Define the report (int) constant.

See Also:
Constant Field Values

ABORT

static final int ABORT
Define the abort (int) constant.

See Also:
Constant Field Values

STATE_STANDBY

static final int STATE_STANDBY
Define the state standby (int) constant.

See Also:
Constant Field Values

STATE_RUNNING

static final int STATE_RUNNING
Define the state running (int) constant.

See Also:
Constant Field Values
Method Detail

abort

void abort()
Abort.


addTaskListener

void addTaskListener(ITaskListener listener)
Add task listener with the specified listener parameter.

Parameters:
listener - The listener (ITaskListener) parameter.
See Also:
removeTaskListener(ITaskListener)

duplicateTask

boolean duplicateTask(ITask task)
Duplicate task with the specified task parameter and return the boolean result.

Parameters:
task - The task (ITask) parameter.
Returns:
Results of the duplicate task (boolean) value.
See Also:
launchTask()

getTaskManager

ITaskManager getTaskManager()
Gets the task manager (ITaskManager) value.

Returns:
The task manager (ITaskManager) value.
See Also:
setTaskManager(ITaskManager)

getTaskName

java.lang.String getTaskName()
Gets the task name (String) value.

Returns:
The task name (String) value.

getTaskOwner

java.lang.Object getTaskOwner()
Gets the task owner (Object) value.

Returns:
The task owner (Object) value.
See Also:
setTaskOwner(Object)

handleResponse

void handleResponse(SignalService source,
                    java.lang.Object timestamp,
                    java.lang.Object data)
Finished with the specified source, timestamp and data parameters and return the boolean result.

Parameters:
source - The source (SignalService) parameter.
timestamp - The timestamp (Object) parameter.
data - The data (Object) parameter.

isResponseExpected

boolean isResponseExpected(SignalService source,
                           java.lang.Object timestamp,
                           java.lang.Object data)
Is response expected with the specified source, timestamp and data parameters and return the boolean result.

Parameters:
source - The source (SignalService) parameter.
timestamp - The time stamp (Object) parameter.
data - The data (Object) parameter.
Returns:
Results of the is response expected (boolean) value.

launchTask

boolean launchTask()
Launch task and return the boolean result.

Returns:
Results of the launch task (boolean) value.
See Also:
duplicateTask(ITask)

notifyListener

void notifyListener(java.lang.String taskName,
                    int status,
                    java.lang.Object result)
Notify listener with the specified finished and result parameters.

Parameters:
taskName - The task name (String) parameter.
status - The status (int) parameter.
result - The result (Object) parameter.
See Also:
addTaskListener(ITaskListener), removeTaskListener(ITaskListener)

removeTaskListener

void removeTaskListener(ITaskListener listener)
Remove task listener with the specified listener parameter.

Parameters:
listener - The listener (ITaskListener) parameter.
See Also:
addTaskListener(ITaskListener)

reset

void reset()
Reset.


setTaskManager

void setTaskManager(ITaskManager taskManager)
Sets the task manager value.

Parameters:
taskManager - The task manager (ITaskManager) parameter.
See Also:
getTaskManager()

setTaskOwner

void setTaskOwner(java.lang.Object taskOwner)
Sets the task owner value.

Parameters:
taskOwner - The task owner (Object) parameter.
See Also:
getTaskOwner()

start

void start()
Start.

See Also:
start(ITaskManager)

start

void start(ITaskManager taskManager)
Start with the specified task manager parameter.

Parameters:
taskManager - The task manager (ITaskManager) parameter.
See Also:
start()

2010-01-26 1.2.0

Copyright (c) 2010 IBM. See license in Legal section.