Package rife.scheduler.taskoptionmanagers

Class MemoryTaskOptions

java.lang.Object

rife.scheduler.taskoptionmanagers.MemoryTaskOptions

All Implemented Interfaces:

TaskOptionManager

public class MemoryTaskOptions
extends Object
implements TaskOptionManager

Constructor Summary

Constructors

Constructor	Description
MemoryTaskOptions()

Method Summary

Modifier and Type	Method	Description
boolean	addTaskOption(TaskOption taskOption)	Adds a new task option to a task.
Scheduler	getScheduler()	Retrieves the scheduler of this task option manager.
TaskOption	getTaskOption(int taskId, String name)	Retrieves a named task options for a particular task.
Collection<TaskOption>	getTaskOptions(int taskId)	Retrieves all the task options for a particular task.
boolean	removeTaskOption(int taskId, String name)	Remove a particular task option.
boolean	removeTaskOption(TaskOption taskOption)	Remove a particular task option.
void	setScheduler(Scheduler scheduler)	Sets the scheduler that uses this task option manager.
boolean	updateTaskOption(TaskOption taskOption)	Update an existing task option.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MemoryTaskOptions

public MemoryTaskOptions()

Method Details

setScheduler

public void setScheduler(Scheduler scheduler)

Description copied from interface: TaskOptionManager

Sets the scheduler that uses this task option manager.

Specified by:

setScheduler in interface TaskOptionManager

Parameters:

scheduler - this task option manager's scheduler

getScheduler

public Scheduler getScheduler()

Description copied from interface: TaskOptionManager

Retrieves the scheduler of this task option manager.

Specified by:

getScheduler in interface TaskOptionManager

Returns:

this task option manager's scheduler; or null if the scheduler hasn't been set

addTaskOption

public boolean addTaskOption(TaskOption taskOption)
                      throws TaskOptionManagerException

Description copied from interface: TaskOptionManager

Adds a new task option to a task.

The provided task option needs to have the appropriate task ID set, otherwise the addition will fail.

Specified by:

addTaskOption in interface TaskOptionManager

Parameters:

taskOption - the task option to add

Returns:

true when the task option was successfully added; or false otherwise

Throws:

TaskOptionManagerException - when an error occurred during the task option addition

updateTaskOption

public boolean updateTaskOption(TaskOption taskOption)
                         throws TaskOptionManagerException

Description copied from interface: TaskOptionManager

Update an existing task option.

The provided task option needs to have the appropriate task ID set, otherwise the update will fail.

Specified by:

updateTaskOption in interface TaskOptionManager

Parameters:

taskOption - the updated task option

Returns:

true if the task option was successfully updated; or false otherwise

Throws:

TaskOptionManagerException

getTaskOption

public TaskOption getTaskOption(int taskId,
 String name)
                         throws TaskOptionManagerException

Description copied from interface: TaskOptionManager

Retrieves a named task options for a particular task.

Specified by:

getTaskOption in interface TaskOptionManager

Parameters:

taskId - the unique ID of the task to retrieve the task option for

name - the name of the task option

Returns:

the retrieved task option instance; or null when the task option couldn't be found

Throws:

TaskOptionManagerException - when an error occurred during the task option retrieval

getTaskOptions

public Collection<TaskOption> getTaskOptions(int taskId)
                                      throws TaskOptionManagerException

Description copied from interface: TaskOptionManager

Retrieves all the task options for a particular task.

Specified by:

getTaskOptions in interface TaskOptionManager

Parameters:

taskId - the unique ID of the task to retrieve the task options for

Returns:

the retrieved task options collection

Throws:

TaskOptionManagerException - when an error occurred during the task option retrieval

removeTaskOption

public boolean removeTaskOption(TaskOption taskOption)
                         throws TaskOptionManagerException

Description copied from interface: TaskOptionManager

Remove a particular task option.

The provided task option needs to have the appropriate task ID set, otherwise the removal will fail.

Specified by:

removeTaskOption in interface TaskOptionManager

Parameters:

taskOption - the task option to remove

Returns:

true when the task option was successfully removed; or false otherwise

Throws:

TaskOptionManagerException - when an error occurred during the task option removal

removeTaskOption

public boolean removeTaskOption(int taskId,
 String name)
                         throws TaskOptionManagerException

Description copied from interface: TaskOptionManager

Remove a particular task option.

Specified by:

removeTaskOption in interface TaskOptionManager

Parameters:

taskId - the unique ID of the task to retrieve the task option for

name - the name of the task option

Returns:

true when the task option was successfully removed; or false otherwise

Throws:

TaskOptionManagerException - when an error occurred during the task option removal