public class TaskList extends AbstractExecutableObject implements ExecutableObject
Title: Service Event Fabric Core
Description: Defines a task container that is intended for execution of a group of ScheduledTask
instances.
Copyright: Copyright (c) 2013
Company: StreamScape Technologies
Modifier and Type | Class and Description |
---|---|
static class |
TaskList.ExecNode |
static interface |
TaskList.ListenerHelper |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
METASET_END |
static java.lang.String |
METASET_START |
static java.lang.String |
MODEL_IMPORT_TAG |
static java.lang.String |
MODEL_TAG |
DEFAULT_SERIAL_VERSION_ID
Modifier and Type | Method and Description |
---|---|
ActionTask |
addActionTask(java.lang.String taskName) |
ActionTask |
addActionTask(java.lang.String taskName,
ActionTask source) |
ActionTask |
addActionTask(java.lang.String taskName,
java.lang.String script) |
ActionTask |
addActionTask(java.lang.String taskName,
java.lang.String sourceListName,
java.lang.String sourceTaskName) |
EventTask |
addEventTask(java.lang.String taskName) |
EventTask |
addEventTask(java.lang.String taskName,
EventTask source) |
EventTask |
addEventTask(java.lang.String taskName,
java.lang.String sourceListName,
java.lang.String sourceTaskName) |
ExceptionTask |
addExceptionTask(java.lang.String taskName,
ExceptionTask source) |
ExceptionTask |
addExceptionTask(java.lang.String taskName,
java.lang.String script) |
ExceptionTask |
addExceptionTask(java.lang.String taskName,
java.lang.String sourceListName,
java.lang.String sourceTaskName) |
RuleSet |
addRuleSet(java.lang.String name,
java.lang.String description,
java.lang.String taskName) |
TaskList.ExecNode |
buildExecutionTree() |
TaskList |
clone()
Do NOT use this method.
|
void |
complete() |
void |
complete(java.lang.String eventKey,
java.lang.String correlationId) |
void |
deleteTask(java.lang.String taskName) |
RowSet |
describeExec(java.lang.String whereClause) |
void |
disableResumptionOn(TaskState state)
Invokes the method
Task.disableResumptionOn(TaskState) for each task of the task list. |
void |
disableResumptionTotally()
Invokes the method
Task.disableResumptionTotally() for each task of the task list. |
void |
enableResumptionOn(TaskState state)
Invokes the method
Task.enableResumptionOn(TaskState) for each task of the task list. |
void |
enableResumptionTotally()
Invokes the method
Task.enableResumptionTotally() for each task of the task list. |
boolean |
equals(java.lang.Object other) |
boolean |
existsExceptionTask() |
boolean |
existsExceptionTask(java.lang.String taskName) |
boolean |
existsExceptionTask(java.util.UUID taskOID) |
boolean |
existsNextTaskAfter(java.lang.String taskName) |
boolean |
existsNextTaskAfter(java.util.UUID taskOID) |
boolean |
existsRuleSet(java.lang.String name) |
boolean |
existsTask(java.lang.String taskName) |
boolean |
existsTask(java.util.UUID taskOID) |
boolean |
existsTaskBefore(java.lang.String taskName) |
void |
fail() |
void |
fail(java.lang.String eventKey,
java.lang.String correlationId) |
java.util.List |
getAllExecChains() |
java.lang.String |
getAuthor()
Returns a name of the user that created this object.
|
java.lang.String |
getBaseModel() |
Task |
getConsequentTask(java.lang.String taskName) |
java.util.Date |
getCreationTime()
Returns a timestamp indicating when the object was created.
|
java.lang.String |
getDescription()
Returns a description of the object.
|
EventScope |
getEventScope()
Returns an event scope for all events or advisories that can be raised or received by the task list or its tasks.
|
ExceptionTask |
getExceptionTask() |
ExceptionTask |
getExceptionTask(java.lang.String taskName) |
ExceptionTask |
getExceptionTask(java.util.UUID taskOID) |
java.util.List |
getExceptionTasks() |
TaskListExecution |
getExecution() |
TaskListExecution |
getExecution(java.lang.String eid) |
Metaset |
getExecutionMetaset() |
java.util.List |
getExecutions() |
java.util.List |
getExecutions(boolean orderByAsc) |
java.util.List |
getExecutions(java.util.Date fromTime,
java.util.Date toTime) |
java.util.List |
getExecutions(java.util.Date fromTime,
java.util.Date toTime,
boolean orderByAsc) |
java.util.List |
getExecutions(java.util.Date fromTime,
java.util.Date toTime,
java.lang.String condition) |
java.util.List |
getExecutions(java.lang.String condition) |
ScheduledJob |
getJob() |
java.lang.String |
getJobName() |
TaskListExecution |
getLastExecution() |
java.util.List |
getLastExecutions(int count) |
java.util.List |
getLastExecutions(int count,
boolean orderByAsc) |
java.util.Date |
getLastUpdateTime()
Returns a timestamp indicating when the object was updated last time.
|
java.lang.String |
getMetasetName()
Returns a name of the Metaset associated with the task list.
|
java.util.UUID |
getMetasetOID()
Returns a unique identifier of the Metaset associated with the task list.
|
java.lang.String |
getName()
Returns a name of the object.
|
Task |
getNextTaskAfter(java.lang.String taskName) |
Task |
getNextTaskAfter(java.util.UUID taskOID) |
java.util.UUID |
getOID()
Returns an unique identifier of the object.
|
java.lang.String |
getOwner()
Returns a name of the owner (user or group) of the object.
|
Task |
getPrecedentTask(java.lang.String taskName) |
long |
getRetentionInterval() |
java.util.concurrent.TimeUnit |
getRetentionIntervalUnit() |
RuleSet |
getRuleSet(java.lang.String name) |
RuleSet |
getRuleSetByExecTask(java.util.UUID taskOID) |
java.util.List |
getRuleSets() |
TaskListState |
getState() |
Task |
getTask(java.lang.String taskName) |
Task |
getTask(java.util.UUID taskOID) |
Task |
getTaskBefore(java.lang.String taskName) |
Task |
getTaskByOrder(int order) |
long |
getTaskDelay() |
java.lang.Long |
getTaskListWindow()
Returns a time interval available for execution of the task list.
|
java.util.concurrent.TimeUnit |
getTaskListWindowUnit()
Returns a time unit for the
taskListWindow parameter. |
int |
getTaskOrder(java.lang.String taskName) |
RowSet |
getTaskOrderList() |
java.util.List |
getTasks() |
boolean |
hasExceptionTasks() |
boolean |
hasJob() |
boolean |
hasTasks() |
ActionTask |
insertActionTask(java.lang.String taskName,
java.lang.String afterTaskName) |
EventTask |
insertEventTask(java.lang.String taskName,
java.lang.String afterTaskName) |
boolean |
isCreatedFromModel() |
boolean |
isDisabled() |
boolean |
isEnabled() |
boolean |
isImportedFromModel() |
java.lang.Boolean |
isModel() |
boolean |
isScheduled() |
boolean |
isTransacted() |
boolean |
isUnordered() |
java.util.List |
listExceptionTasks() |
java.util.List |
listRules() |
java.util.List |
listTasks() |
void |
moveTask(java.lang.String taskName,
java.lang.String afterTaskName) |
void |
removeExceptionTask() |
void |
removeExceptionTask(java.lang.String taskName) |
void |
removeRuleSet(java.lang.String name) |
void |
removeTask(java.lang.String taskName) |
void |
setAutoComplete(boolean autoComplete) |
void |
setDescription(java.lang.String description)
Sets the specified description of the object.
|
void |
setEventScope(EventScope eventScope)
Sets the specified event scope of the task list.
|
void |
setMetaset(java.lang.String name)
Sets a name of the Metaset associated with the task list.
|
void |
setModel() |
void |
setName(java.lang.String name)
Sets the specified object name.
|
void |
setRetentionInterval(long retentionInterval) |
void |
setRetentionIntervalUnit(java.util.concurrent.TimeUnit retentionIntervalUnit) |
void |
setTaskDelay(long taskDelay) |
void |
setTaskListWindow(long taskListWindow)
Sets the specified task list window.
|
void |
setTaskListWindowUnit(java.util.concurrent.TimeUnit unit)
Sets the specified task list window unit.
|
void |
setTaskWindowUnit(java.util.concurrent.TimeUnit unit)
Invokes the method
Task.setTaskWindowUnit(TimeUnit) for each task of the task list. |
void |
setTransacted(boolean transacted) |
void |
setUnordered(boolean unordered) |
java.util.List |
testExecution(Metaset metaset) |
java.lang.String |
toString() |
void |
update()
Updates the task list in the storage.
|
addTag, clearProperties, clearTags, existsProperty, existsTag, getEndTimeMsec, getExpirationDate, getMetadata, getProperties, getProperty, getPropertyList, getPropertyResolved, isAutoComplete, listProperties, listTags, putProperty, removeProperty, removeTag, setMetadata, setTaskWindow
getSerialVersionUID
getClass, hashCode, notify, notifyAll, wait, wait, wait
addTag, clearProperties, clearTags, existsProperty, existsTag, getEndTimeMsec, getExpirationDate, getMetadata, getProperties, getProperty, getPropertyList, getPropertyResolved, listTags, putProperty, removeProperty, removeTag, setMetadata, setTaskWindow
getAuthor, getCreationTime, getLastUpdateTime, getOID, getOwner
getDescription, setDescription, setName
getName
public static final java.lang.String MODEL_TAG
public static final java.lang.String MODEL_IMPORT_TAG
public static final java.lang.String METASET_START
public static final java.lang.String METASET_END
public ScheduledJob getJob()
public boolean hasJob()
public java.lang.String getJobName()
public void update() throws SchedulerException
TaskList
instance, this method is an only way
to save the changes that made to this copy. This method replaces (not merges!) all values of the stored task list
by corresponding values of the specified task list. After calling this method, any changes of the task list instance
will have no effect until the next method call.
This operation is allowed only if the current user is owner of the task list or has administrator rights.
This method MUST NOT be used if the task list is deserialized from any format (for example, on the remote side).
taskList
- the task list to be updated.SchedulerException
- if the current user has insufficient rights for this operation or
if the task list is not disabled or
if some other error occurs.public java.lang.Long getTaskListWindow()
public void setTaskListWindow(long taskListWindow)
getTaskListWindow()
for further information.taskWindow
- the value to be set.public java.util.concurrent.TimeUnit getTaskListWindowUnit()
taskListWindow
parameter.
TimeUnit.SECONDS
.taskListWindow
parameter.public void setTaskListWindowUnit(java.util.concurrent.TimeUnit unit) throws SchedulerException
getTaskListWindowUnit()
for further information.unit
- the value to be set.SchedulerException
- if the unit is null
.public void setTaskWindowUnit(java.util.concurrent.TimeUnit unit) throws SchedulerException
Task.setTaskWindowUnit(TimeUnit)
for each task of the task list.setTaskWindowUnit
in interface ExecutableObject
setTaskWindowUnit
in class AbstractExecutableObject
unit
- the value to be set.SchedulerException
- if the unit is null
.public void enableResumptionOn(TaskState state) throws SchedulerException
Task.enableResumptionOn(TaskState)
for each task of the task list.enableResumptionOn
in interface ExecutableObject
enableResumptionOn
in class AbstractExecutableObject
state
- the value to be set.SchedulerException
- if the state is not suitable.public void enableResumptionTotally() throws SchedulerException
Task.enableResumptionTotally()
for each task of the task list.enableResumptionTotally
in interface ExecutableObject
enableResumptionTotally
in class AbstractExecutableObject
SchedulerException
public void disableResumptionOn(TaskState state) throws SchedulerException
Task.disableResumptionOn(TaskState)
for each task of the task list.disableResumptionOn
in interface ExecutableObject
disableResumptionOn
in class AbstractExecutableObject
state
- the value to be set.SchedulerException
- if the state is not suitable.public void disableResumptionTotally() throws SchedulerException
Task.disableResumptionTotally()
for each task of the task list.disableResumptionTotally
in interface ExecutableObject
disableResumptionTotally
in class AbstractExecutableObject
SchedulerException
public long getRetentionInterval()
public void setRetentionInterval(long retentionInterval) throws SchedulerException
SchedulerException
public java.util.concurrent.TimeUnit getRetentionIntervalUnit()
public void setRetentionIntervalUnit(java.util.concurrent.TimeUnit retentionIntervalUnit) throws SchedulerException
SchedulerException
public void setAutoComplete(boolean autoComplete)
public boolean isUnordered()
public void setUnordered(boolean unordered) throws SchedulerException
SchedulerException
public boolean isTransacted()
public void setTransacted(boolean transacted)
public EventScope getEventScope()
GLOBAL
.public void setEventScope(EventScope eventScope) throws SchedulerException
OBSERVABLE
or GLOBAL
.eventScope
- the event scope to be set.SchedulerException
- if the specified event scope neither OBSERVABLE
nor GLOBAL
.public java.lang.Boolean isModel()
public void setModel()
public boolean isCreatedFromModel()
public boolean isImportedFromModel()
public java.lang.String getBaseModel()
public ActionTask addActionTask(java.lang.String taskName) throws SchedulerException
SchedulerException
public ActionTask addActionTask(java.lang.String taskName, java.lang.String script) throws SchedulerException
SchedulerException
public ActionTask addActionTask(java.lang.String taskName, java.lang.String sourceListName, java.lang.String sourceTaskName) throws SchedulerException
SchedulerException
public ActionTask addActionTask(java.lang.String taskName, ActionTask source) throws SchedulerException
SchedulerException
public EventTask addEventTask(java.lang.String taskName) throws SchedulerException
SchedulerException
public EventTask addEventTask(java.lang.String taskName, java.lang.String sourceListName, java.lang.String sourceTaskName) throws SchedulerException
SchedulerException
public EventTask addEventTask(java.lang.String taskName, EventTask source) throws SchedulerException
SchedulerException
public ExceptionTask addExceptionTask(java.lang.String taskName, java.lang.String script) throws SchedulerException
SchedulerException
public ExceptionTask addExceptionTask(java.lang.String taskName, java.lang.String sourceListName, java.lang.String sourceTaskName) throws SchedulerException
SchedulerException
public ExceptionTask addExceptionTask(java.lang.String taskName, ExceptionTask source) throws SchedulerException
SchedulerException
public ActionTask insertActionTask(java.lang.String taskName, java.lang.String afterTaskName) throws SchedulerException
SchedulerException
public EventTask insertEventTask(java.lang.String taskName, java.lang.String afterTaskName) throws SchedulerException
SchedulerException
public void moveTask(java.lang.String taskName, java.lang.String afterTaskName) throws SchedulerException
SchedulerException
public void removeTask(java.lang.String taskName)
public void deleteTask(java.lang.String taskName) throws SchedulerException
SchedulerException
public void removeExceptionTask(java.lang.String taskName)
public void removeExceptionTask()
public boolean existsNextTaskAfter(java.util.UUID taskOID)
public Task getNextTaskAfter(java.util.UUID taskOID)
public boolean existsNextTaskAfter(java.lang.String taskName)
public Task getNextTaskAfter(java.lang.String taskName)
public Task getConsequentTask(java.lang.String taskName)
public boolean existsTaskBefore(java.lang.String taskName)
public Task getTaskBefore(java.lang.String taskName)
public Task getPrecedentTask(java.lang.String taskName)
public boolean existsTask(java.lang.String taskName)
public boolean existsTask(java.util.UUID taskOID)
public Task getTask(java.lang.String taskName)
public Task getTask(java.util.UUID taskOID)
public boolean existsExceptionTask()
public ExceptionTask getExceptionTask()
public boolean existsExceptionTask(java.lang.String taskName)
public boolean existsExceptionTask(java.util.UUID taskOID)
public ExceptionTask getExceptionTask(java.lang.String taskName)
public ExceptionTask getExceptionTask(java.util.UUID taskOID)
public java.util.List getTasks()
public java.util.List listTasks()
public java.util.List getExceptionTasks()
public java.util.List listExceptionTasks()
public boolean hasTasks()
public boolean hasExceptionTasks()
public long getTaskDelay()
public void setTaskDelay(long taskDelay) throws SchedulerException
SchedulerException
public java.util.UUID getMetasetOID()
public java.lang.String getMetasetName()
This method returns null
if the object is deserialized from any format (for example, on the remote side).
public void setMetaset(java.lang.String name) throws SchedulerException
name
- the name of the metaset to be set.SchedulerException
- if the specified metaset does not exist.public TaskListState getState()
public boolean isEnabled()
public boolean isDisabled()
public boolean isScheduled()
public TaskList.ExecNode buildExecutionTree() throws SchedulerException
SchedulerException
public java.util.List getAllExecChains() throws SchedulerException
SchedulerException
public java.util.List testExecution(Metaset metaset) throws SchedulerException
SchedulerException
public int getTaskOrder(java.lang.String taskName)
public RowSet getTaskOrderList()
public Task getTaskByOrder(int order)
public TaskListExecution getExecution()
public TaskListExecution getLastExecution()
public TaskListExecution getExecution(java.lang.String eid) throws SchedulerException
SchedulerException
public java.util.List getExecutions() throws SchedulerException
SchedulerException
public java.util.List getExecutions(boolean orderByAsc) throws SchedulerException
SchedulerException
public java.util.List getExecutions(java.util.Date fromTime, java.util.Date toTime) throws SchedulerException
SchedulerException
public java.util.List getExecutions(java.util.Date fromTime, java.util.Date toTime, boolean orderByAsc) throws SchedulerException
SchedulerException
public java.util.List getExecutions(java.util.Date fromTime, java.util.Date toTime, java.lang.String condition) throws SchedulerException
SchedulerException
public java.util.List getExecutions(java.lang.String condition) throws SchedulerException
SchedulerException
public java.util.List getLastExecutions(int count) throws SchedulerException
SchedulerException
public java.util.List getLastExecutions(int count, boolean orderByAsc) throws SchedulerException
SchedulerException
public RowSet describeExec(java.lang.String whereClause) throws SchedulerException
SchedulerException
public Metaset getExecutionMetaset()
public void complete() throws SchedulerException
SchedulerException
public void complete(java.lang.String eventKey, java.lang.String correlationId) throws SchedulerException
SchedulerException
public void fail() throws SchedulerException
SchedulerException
public void fail(java.lang.String eventKey, java.lang.String correlationId) throws SchedulerException
SchedulerException
public RuleSet addRuleSet(java.lang.String name, java.lang.String description, java.lang.String taskName) throws SchedulerException
SchedulerException
public void removeRuleSet(java.lang.String name)
public RuleSet getRuleSet(java.lang.String name)
public boolean existsRuleSet(java.lang.String name)
public java.util.List listRules()
public java.util.List getRuleSets()
public RuleSet getRuleSetByExecTask(java.util.UUID taskOID)
public java.lang.String toString()
public TaskList clone()
clone
in interface CloneableObject
clone
in class CloneableDataObject
public java.util.UUID getOID()
SchedulerObject
getOID
in interface SchedulerObject
public java.lang.String getName()
NamedObject
getName
in interface NamedObject
public void setName(java.lang.String name) throws SchedulerException
DescribedNamedObject
setName
in interface DescribedNamedObject
name
- the name to be set.SchedulerException
- if the name has wrong format.public java.lang.String getDescription()
DescribedNamedObject
getDescription
in interface DescribedNamedObject
public void setDescription(java.lang.String description)
DescribedNamedObject
setDescription
in interface DescribedNamedObject
description
- the value to be set.public java.lang.String getAuthor()
SchedulerObject
getAuthor
in interface SchedulerObject
public java.lang.String getOwner()
SchedulerObject
getOwner
in interface SchedulerObject
public java.util.Date getCreationTime()
SchedulerObject
getCreationTime
in interface SchedulerObject
public java.util.Date getLastUpdateTime()
SchedulerObject
getLastUpdateTime
in interface SchedulerObject
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.