public interface Scheduler
Title: Service Event Fabric Core
Description: Defines a manager that controls various types of the Scheduled Object instances.
TaskList
)SingleJob
)RepeatingJob
)EventTaskTrigger
)TaskListExecution
)Copyright: Copyright (c) 2020
Company: StreamScape Technologies
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADVISORY_EMAIL_SUBJECT |
static java.lang.String |
ADVISORY_EMAIL_TO |
Modifier and Type | Method and Description |
---|---|
void |
abortTask(java.lang.String listName,
java.lang.String taskName)
Tries to abort the execution of the specified task.
|
void |
abortTaskList(java.lang.String listName)
Tries to abort the execution of the specified task list.
|
void |
addTemplate(TemplateType type,
java.lang.String name,
java.lang.String value)
Adds a new template with the specified parameters.
|
void |
addTimeWindow(TimeWindow window)
Adds the specified time window.
|
void |
completeTask(java.lang.String listName,
java.lang.String taskName)
Completes the execution of the specified task by raising a Completion Event (
[event.Scheduler.Completion] ). |
void |
completeTask(java.lang.String listName,
java.lang.String taskName,
java.util.Map facets)
Completes the execution of the specified task by raising a Completion Event (
[event.Scheduler.Completion] ). |
void |
completeTask(java.lang.String nodeName,
java.lang.String listName,
java.lang.String taskName,
java.util.Map facets)
Completes the execution of the specified task in the specified node by raising a Completion Event (
[event.Scheduler.Completion] ). |
void |
completeTaskList(java.lang.String listName)
Completes the execution of the specified task list by raising a Completion Event (
[event.Scheduler.Completion] ). |
void |
completeTaskList(java.lang.String listName,
java.util.Map facets)
Completes the execution of the specified task list by raising a Completion Event (
[event.Scheduler.Completion] ). |
void |
completeTaskList(java.lang.String nodeName,
java.lang.String listName,
java.util.Map facets)
Completes the execution of the specified task list in the specified node by raising a Completion Event (
[event.Scheduler.Completion] ). |
ScheduledJob |
createJob(java.lang.String name,
ScheduledJob source) |
Metaset |
createMetaset(java.lang.String name,
java.lang.String description,
java.util.Map values,
boolean isStatic)
Creates a new Metaset with the specified parameters.
|
RepeatingJob |
createRepeatingJob(java.lang.String name)
Creates a new Repeating Job with the specified name.
|
RepeatingJob |
createRepeatingJob(java.lang.String name,
RepeatingJob source) |
RepeatingJob |
createRepeatingJob(java.lang.String name,
java.lang.String sourceName)
Creates a new Repeating Job based on the specified source job.
|
SingleJob |
createSingleJob(java.lang.String name)
Creates a new Single Job with the specified name.
|
SingleJob |
createSingleJob(java.lang.String name,
SingleJob source) |
SingleJob |
createSingleJob(java.lang.String name,
java.lang.String sourceName)
Creates a new Single Job based on the specified source job.
|
TaskList |
createTaskList(java.lang.String name)
Creates a new Task List with the specified name.
|
TaskList |
createTaskList(java.lang.String name,
java.lang.String sourceName)
Creates a new Task List based on the specified source list.
|
TaskList |
createTaskList(java.lang.String name,
TaskList source)
Creates a new Task List based on the specified source list.
|
TaskList |
createTaskList(java.lang.String name,
TaskList source,
boolean asModel)
Creates a new Task List based on the specified source list.
|
EventTaskTrigger |
createTrigger(java.lang.String name)
Creates a new Event Task Trigger.
|
EventTaskTrigger |
createTrigger(java.lang.String name,
java.lang.String sourceName)
Creates a new Event Task Trigger based on the specified source trigger.
|
void |
disableJob(java.lang.String name)
Disables the specified job, cancelling the execution schedule.
|
void |
disableTaskList(java.lang.String name)
Disables the specified task list, allowing to modify it.
|
void |
dropJob(java.lang.String name)
Drops a job with the specified name.
|
void |
dropMetaset(java.lang.String name)
Drops a Metaset with the specified name.
|
void |
dropTaskList(java.lang.String name)
Drops a task list with the specified name.
|
void |
dropTrigger(java.lang.String name)
Drops an Event Task Trigger with the specified name.
|
void |
enableJob(java.lang.String name)
Enables the specified job, allowing it to schedule for execution.
|
void |
enableTaskList(java.lang.String name)
Enables the specified task list, allowing to execute it.
|
TaskListState |
executeTask(java.lang.String listName,
java.lang.String taskName)
Directly executes the specified task of the specified task list.
|
TaskListState |
executeTask(java.lang.String listName,
java.lang.String taskName,
Metaset metaset)
Directly executes the specified task of the specified task list.
|
TaskListState |
executeTask(java.lang.String listName,
java.lang.String taskName,
Metaset metaset,
java.util.Date untilTime)
Directly executes the specified task of the specified task list.
|
TaskListState |
executeTask(java.lang.String listName,
java.lang.String taskName,
Metaset metaset,
ExecutionListener listener,
java.util.Date untilTime)
Directly executes the specified task of the specified task list, using the specified listener to monitor the execution state.
|
TaskListState |
executeTaskList(java.lang.String name)
Directly executes the specified task list.
|
TaskListState |
executeTaskList(java.lang.String name,
Metaset metaset)
Directly executes the specified task list.
|
TaskListState |
executeTaskList(java.lang.String name,
Metaset metaset,
java.util.Date untilTime)
Directly executes the specified task list.
|
TaskListState |
executeTaskList(java.lang.String name,
Metaset metaset,
ExecutionListener listener,
java.util.Date untilTime)
Directly executes the specified task list, using the specified listener to monitor the execution state.
|
boolean |
existsJob(java.lang.String name)
Checks if a job with the specified name exists.
|
boolean |
existsMetaset(java.lang.String name)
Checks if a Metaset with the specified name exists.
|
boolean |
existsTaskList(java.lang.String name)
Checks if a task list with the specified name exists.
|
boolean |
existsTemplate(TemplateType type,
java.lang.String name)
Checks if the specified template exists.
|
boolean |
existsTimeWindow(java.lang.String name)
Check if a time window with the specified name exists.
|
boolean |
existsTrigger(java.lang.String name)
Checks if an Event Task Trigger with the specified name exists.
|
void |
expireTask(java.lang.String listName,
java.lang.String taskName)
Expires the execution of the specified task by raising a Completion Event (
[event.Scheduler.Completion] )
with the isExpired parameter set to true . |
void |
expireTask(java.lang.String nodeName,
java.lang.String listName,
java.lang.String taskName)
Expires the execution of the specified task in the specified node by raising a Completion Event (
[event.Scheduler.Completion] )
with the isExpired parameter set to true . |
void |
expireTaskList(java.lang.String listName)
Expires the execution of the specified task list by raising a Completion Event (
[event.Scheduler.Completion] )
with the isExpired parameter set to true . |
void |
expireTaskList(java.lang.String nodeName,
java.lang.String listName)
Expires the execution of the specified task list in the specified node by raising a Completion Event (
[event.Scheduler.Completion] )
with the isExpired parameter set to true . |
void |
failTask(java.lang.String listName,
java.lang.String taskName)
Fails the execution of the specified task by raising a Completion Event (
[event.Scheduler.Completion] )
with the isFailed parameter set to true . |
void |
failTask(java.lang.String nodeName,
java.lang.String listName,
java.lang.String taskName)
Fails the execution of the specified task in the specified node by raising a Completion Event (
[event.Scheduler.Completion] )
with the isFailed parameter set to true . |
void |
failTaskList(java.lang.String listName)
Fails the execution of the specified task list by raising a Completion Event (
[event.Scheduler.Completion] )
with the isFailed parameter set to true . |
void |
failTaskList(java.lang.String nodeName,
java.lang.String listName)
Fails the execution of the specified task list in the specified node by raising a Completion Event (
[event.Scheduler.Completion] )
with the isFailed parameter set to true . |
java.util.Map |
getAllExecutions(java.util.Date fromTime,
java.util.Date toTime)
Returns a list of executions of all task lists performed within the specified time window (including the boundaries).
|
java.util.Map |
getAllExecutions(java.util.Date fromTime,
java.util.Date toTime,
boolean orderByAsc)
Returns a list of executions of all task lists performed within the specified time window (including the boundaries).
|
java.util.Map |
getAllExecutions(java.util.Date fromTime,
java.util.Date toTime,
java.lang.String condition)
Returns a list of executions of all task lists performed within the specified time window (including the boundaries).
|
java.util.Map |
getAllExecutions(java.lang.String condition)
Returns a list of executions of all task lists.
|
TaskListExecution |
getExecution(java.lang.String listName,
java.lang.String eid)
Returns the specified execution of the specified task list.
|
TaskListExecution |
getExecution(java.lang.String listName,
java.util.UUID eid)
Returns the specified execution of the specified task list.
|
java.util.List |
getExecutions(java.lang.String listName)
Returns a list of all executions of the specified task list.
|
java.util.List |
getExecutions(java.lang.String listName,
boolean orderByAsc)
Returns a list of all executions of the specified task list.
|
java.util.List |
getExecutions(java.lang.String listName,
java.util.Date fromTime,
java.util.Date toTime)
Returns a list of executions of the specified task list performed within the specified time window (including the boundaries).
|
java.util.List |
getExecutions(java.lang.String listName,
java.util.Date fromTime,
java.util.Date toTime,
boolean orderByAsc)
Returns a list of executions of the specified task list performed within the specified time window (including the boundaries).
|
java.util.List |
getExecutions(java.lang.String listName,
java.util.Date fromTime,
java.util.Date toTime,
java.lang.String condition)
Returns a list of executions of the specified task list performed within the specified time window (including the boundaries).
|
java.util.List |
getExecutions(java.lang.String listName,
int fromIndex,
int toIndex)
Returns a list of executions of the specified task list located between the specified
fromIndex (inclusive)
and toIndex (exclusive). |
java.util.List |
getExecutions(java.lang.String listName,
java.lang.String condition)
Returns a list of all executions of the specified task list.
|
int |
getExecutionsNumber(java.lang.String listName)
Returns the number of executions of the specified task list.
|
int |
getExecutionsNumber(java.lang.String listName,
java.util.Date fromTime,
java.util.Date toTime)
Returns the number of executions of the specified task list performed within the specified time window (including the boundaries).
|
ScheduledJob |
getJob(java.lang.String name)
Returns a job with the specified name.
|
ScheduledJob |
getJob(java.util.UUID oid)
Returns a job with the specified object identifier.
|
java.util.List |
getJobs()
Returns a list of all jobs.
|
java.util.List |
getJobs(java.util.Date time)
Returns a list of all jobs (working or not) scheduled for execution at the specified time.
|
java.util.List |
getJobs(java.util.Date fromTime,
java.util.Date toTime)
Returns a list of all jobs (working or not) scheduled for execution within the specified time window
(including the boundaries).
|
TaskListExecution |
getLastExecution(java.lang.String listName)
Returns a last execution of the specified task list.
|
TaskListExecution |
getLastExecution(java.util.UUID oid)
Returns a last execution of the specified task list.
|
java.util.List |
getLastExecutions(java.lang.String listName,
int count)
Returns a specified number of last executions of the specified task list.
|
java.util.List |
getLastExecutions(java.lang.String listName,
int count,
boolean orderByAsc)
Returns a specified number of last executions of the specified task list.
|
Metaset |
getMetaset(java.lang.String name)
Returns a new instance of the Metaset with the specified name.
|
Metaset |
getMetaset(java.util.UUID oid)
Returns a new instance of the Metaset with the specified object identifier.
|
java.util.List |
getMetasets()
Returns a list of all Metaset instances.
|
java.lang.String |
getParameter(java.lang.String name)
Returns a value of the specified parameter.
|
SchedulerState |
getState()
Returns the current state of the Scheduler.
|
TaskList |
getTaskList(java.lang.String name)
Returns a task list with the specified name.
|
TaskList |
getTaskList(java.util.UUID oid)
Returns a task list with the specified object identifier.
|
java.util.List |
getTaskLists()
Returns a list of all task lists.
|
java.lang.String |
getTemplate(TemplateType type,
java.lang.String name)
Returns a value of the specified template.
|
TimeWindow |
getTimeWindow(java.lang.String name)
Returns a time window with the specified name.
|
java.util.List |
getTimeWindows()
Returns a list of all time windows.
|
EventTaskTrigger |
getTrigger(java.lang.String name)
Returns an Event Task Trigger with the specified name.
|
java.util.List |
getTriggers()
Returns a list of all Event Task Triggers.
|
java.lang.String |
getUserName()
Returns a name of the current user of the Scheduler.
|
java.util.List |
listJobs()
Returns a list of names of all jobs.
|
java.util.List |
listMetasets()
Returns a list of names of all Metasets.
|
java.util.List |
listParameters()
Returns a list of all parameter names.
|
java.util.List |
listTaskLists()
Returns a list of names of all task lists.
|
java.util.List |
listTemplates(TemplateType type)
Returns a list of templates of the specified type.
|
java.util.List |
listTimeWindows()
Returns a list of name of all time windows.
|
java.util.List |
listTriggers()
Returns a list of names of all Event Task Triggers.
|
void |
purgeExecutions(java.lang.String listName)
Removes all stored executions of the specified task list.
|
void |
purgeExecutions(java.lang.String listName,
java.util.Date fromTime,
java.util.Date toTime)
Removes stored executions of the specified task list performed withing the specified time window (including the boundaries).
|
void |
purgeJobs()
Removes all finished jobs.
|
void |
purgeJobs(java.util.Date time)
Removes all finished jobs scheduled for execution at the specified time.
|
void |
purgeJobs(java.util.Date fromTime,
java.util.Date toTime)
Removes all finished jobs scheduled for execution withing the specified time window (including the boundaries).
|
void |
removeTemplate(TemplateType type,
java.lang.String name)
Removes the specified template.
|
void |
removeTimeWindow(java.lang.String name)
Removes the specified time window.
|
void |
setJobOwner(java.lang.String jobName,
java.lang.String ownerName)
Assigns the specified owner to the specified job.
|
void |
setJobTaskList(java.lang.String jobName,
java.lang.String listName)
Assigns the specified task list to be scheduled by the specified job.
|
void |
setParameter(java.lang.String name,
java.lang.String value)
Sets the specified value of the specified parameter.
|
void |
setTaskListOwner(java.lang.String listName,
java.lang.String ownerName)
Assigns the specified owner to the specified task list.
|
void |
setTemplate(TemplateType type,
java.lang.String name,
java.lang.String value)
Sets the specified value to the specified template.
|
void |
setTimeWindow(TimeWindow window)
Updates the existing time window.
|
java.lang.String |
startTask(java.lang.String listName,
java.lang.String taskName)
Asynchronously starts direct execution of the specified task in the specified task list.
|
java.lang.String |
startTask(java.lang.String listName,
java.lang.String taskName,
Metaset metaset)
Asynchronously starts direct execution of the specified task in the specified task list.
|
java.lang.String |
startTask(java.lang.String listName,
java.lang.String taskName,
Metaset metaset,
java.util.Date untilTime)
Asynchronously starts direct execution of the specified task in the specified task list.
|
java.lang.String |
startTaskList(java.lang.String name)
Asynchronously starts direct execution of the specified task list.
|
java.lang.String |
startTaskList(java.lang.String name,
Metaset metaset)
Asynchronously starts direct execution of the specified task list.
|
java.lang.String |
startTaskList(java.lang.String name,
Metaset metaset,
java.util.Date untilTime)
Asynchronously starts direct execution of the specified task list.
|
void |
updateJob(ScheduledJob job)
Updates the specified job in the storage.
|
Metaset |
updateMetaset(java.lang.String name,
java.lang.String description,
java.util.Map values,
java.lang.Boolean isStatic)
Updates the specified Metaset with the specified parameters.
|
void |
updateTaskList(TaskList taskList)
Updates the specified task list in the storage.
|
static final java.lang.String ADVISORY_EMAIL_SUBJECT
static final java.lang.String ADVISORY_EMAIL_TO
SchedulerState getState()
java.lang.String getUserName()
java.lang.String getParameter(java.lang.String name)
name
- the parameter name.null
if this parameter is not supported.void setParameter(java.lang.String name, java.lang.String value) throws SchedulerException
MacroProcessor
for details).
This operation is allowed only if the current user has administrator rights.
name
- the name of the parameter.value
- the value to be set.SchedulerException
- if the specified parameter is not supported or
if the current user has insufficient rights for this operation or
if some other error occurs.java.util.List listParameters()
TaskList createTaskList(java.lang.String name) throws SchedulerException
TaskList
instance.
So the object returned by this method will not reflect further changes of the corresponding task list.
TaskList
instance the method updateTaskList(TaskList)
must be used.name
- the name of the task list.SchedulerException
- if a task list with the specified name already exists or
if some other error occurs.TaskList createTaskList(java.lang.String name, java.lang.String sourceName) throws SchedulerException
TaskList
instance.
So the object returned by this method will not reflect further changes of the corresponding task list.
TaskList
instance the method updateTaskList(TaskList)
must be used.name
- the name of the task list to be created.sourceName
- the name of the source task list.SchedulerException
- if a task list with the specified name already exists or
if the source task list does not exist or
if some other error occurs.TaskList createTaskList(java.lang.String name, TaskList source) throws SchedulerException
TaskList
instance.
So the object returned by this method will not reflect further changes of the corresponding task list.
TaskList
instance the method updateTaskList(TaskList)
must be used.name
- the name of the task list to be created.source
- the source task list.SchedulerException
- if a task list with the specified name already exists or
if some other error occurs.TaskList createTaskList(java.lang.String name, TaskList source, boolean asModel) throws SchedulerException
TaskList
instance.
So the object returned by this method will not reflect further changes of the corresponding task list.
TaskList
instance the method updateTaskList(TaskList)
must be used.name
- the name of the task list to be created.source
- the source task list.asModel
- the flag indicating if the task list will be created as a Task List Model if the source list is a Model.SchedulerException
- if a task list with the specified name already exists or
if some other error occurs.void dropTaskList(java.lang.String name) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
name
- the name of the task list.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.void updateTaskList(TaskList taskList) 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 specified 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.
taskList
- the task list to be updated.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is not disabled or
if some other error occurs.void setTaskListOwner(java.lang.String listName, java.lang.String ownerName) throws SchedulerException
This operation is allowed only if the current user has administrator rights.
listName
- the name of the task list.ownerName
- the name of the new owner.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is not disabled or
if some other error occurs.void enableTaskList(java.lang.String name) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
name
- the name of the task list.SchedulerException
- if the current user has insufficient rights for this operation or
if some other error occurs.void disableTaskList(java.lang.String name) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
name
- the name of the task list.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is currently running or
if some other error occurs.boolean existsTaskList(java.lang.String name)
name
- the name of the task list.true
if the specified task list exists, false
otherwise.TaskList getTaskList(java.lang.String name)
TaskList
instance.
So the object returned by this method will not reflect further changes of the corresponding task list.
updateTaskList(TaskList)
must be used.name
- the name of the task list.null
if the corresponding task list does not exist.TaskList getTaskList(java.util.UUID oid)
TaskList
instance.
So the object returned by this method will not reflect further changes of the corresponding task list.
updateTaskList(TaskList)
must be used.oid
- the object identifier of the task list.null
if the corresponding task list does not exist.java.util.List getTaskLists()
TaskList
instances.
So the objects returned by this method will not reflect further changes of the corresponding task lists.
updateTaskList(TaskList)
must be used.java.util.List listTaskLists()
TaskListState executeTaskList(java.lang.String name) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
name
- the name of the task list.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is already running or
if some other error occurs.TaskListState executeTaskList(java.lang.String name, Metaset metaset) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
name
- the name of the task list.metaset
- the instance of the Metaset (set of key-value pairs) that is accessible by the task list and its tasks during execution.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is already running or
if some other error occurs.TaskListState executeTaskList(java.lang.String name, Metaset metaset, java.util.Date untilTime) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
name
- the name of the task list.metaset
- the instance of the Metaset (set of key-value pairs) that is accessible by the task list and its tasks during execution.untilTime
- the time until execution of the task list must be completed.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is already running or
if some other error occurs.TaskListState executeTaskList(java.lang.String name, Metaset metaset, ExecutionListener listener, java.util.Date untilTime) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
name
- the name of the task list.metaset
- the instance of the Metaset (set of key-value pairs) that is accessible by the task list and its tasks during execution.listener
- the listener that reacts to change of the execution state.untilTime
- the time until execution of the task list must be completed.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is already running or
if some other error occurs.java.lang.String startTaskList(java.lang.String name) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
name
- the string representation of the current Execution ID.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is already running or
if some other error occurs.java.lang.String startTaskList(java.lang.String name, Metaset metaset) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
name
- the name of the task list.metaset
- the instance of the Metaset (set of key-value pairs) that is accessible by the task list and its tasks during execution.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is already running or
if some other error occurs.java.lang.String startTaskList(java.lang.String name, Metaset metaset, java.util.Date untilTime) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
name
- the name of the task list.metaset
- the instance of the Metaset (set of key-value pairs) that is accessible by the task list and its tasks during execution.untilTime
- the time until execution of the task list must be completed.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is already running or
if some other error occurs.void abortTaskList(java.lang.String listName) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
listName
- the name of the task to be aborted.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is not running or
if some other error occurs.void completeTaskList(java.lang.String listName) throws SchedulerException
[event.Scheduler.Completion]
).
This method is only applicable for non-autocomplete task lists.
listName
- the name of the task list to be completed.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is not running or
if some other error occurs.void completeTaskList(java.lang.String listName, java.util.Map facets) throws SchedulerException
[event.Scheduler.Completion]
).
This method is only applicable for non-autocomplete task lists.
listName
- the name of the task list to be completed.facets
- the list of name-value pair passed to the task list.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is not running or
if some other error occurs.void completeTaskList(java.lang.String nodeName, java.lang.String listName, java.util.Map facets) throws SchedulerException
[event.Scheduler.Completion]
).
This method is only applicable for non-autocomplete task lists.
nodeName
- the name of the node containing the task list.listName
- the name of the task list to be completed.facets
- the list of name-value pair passed to the task list.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is not running or
if some other error occurs.void failTaskList(java.lang.String listName) throws SchedulerException
[event.Scheduler.Completion]
)
with the isFailed
parameter set to true
.
This method is only applicable for non-autocomplete task lists.
listName
- the name of the task list to be failed.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is not running or
if some other error occurs.void failTaskList(java.lang.String nodeName, java.lang.String listName) throws SchedulerException
[event.Scheduler.Completion]
)
with the isFailed
parameter set to true
.
This method is only applicable for non-autocomplete task lists.
nodeName
- the name of the node containing the task list.listName
- the name of the task list to be failed.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is not running or
if some other error occurs.void expireTaskList(java.lang.String listName) throws SchedulerException
[event.Scheduler.Completion]
)
with the isExpired
parameter set to true
.
This method is only applicable for non-autocomplete task lists.
listName
- the name of the task list to be completed.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is not running or
if some other error occurs.void expireTaskList(java.lang.String nodeName, java.lang.String listName) throws SchedulerException
[event.Scheduler.Completion]
)
with the isExpired
parameter set to true
.
This method is only applicable for non-autocomplete task lists.
nodeName
- the name of the node containing the task list.listName
- the name of the task list to be completed.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is not running or
if some other error occurs.TaskListState executeTask(java.lang.String listName, java.lang.String taskName) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
listName
- the name of the task list containing the task.taskName
- the name of the task to be executed.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is already running or
if some other error occurs.TaskListState executeTask(java.lang.String listName, java.lang.String taskName, Metaset metaset) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
listName
- the name of the task list containing the task to be executed.taskName
- the name of the task to be executed.metaset
- the instance of the Metaset (set of key-value pairs) that is accessible by the task during execution.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task list or one of its task is already running or
if some other error occurs.TaskListState executeTask(java.lang.String listName, java.lang.String taskName, Metaset metaset, java.util.Date untilTime) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
listName
- the name of the task list containing the task to be executed.taskName
- the name of the task to be executed.metaset
- the instance of the Metaset (set of key-value pairs) that is accessible by the task during execution.untilTime
- the time until execution of the task must be completed.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task list or one of its task is already running or
if some other error occurs.TaskListState executeTask(java.lang.String listName, java.lang.String taskName, Metaset metaset, ExecutionListener listener, java.util.Date untilTime) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
listName
- the name of the task list containing the task to be executed.taskName
- the name of the task to be executed.metaset
- the instance of the Metaset (set of key-value pairs) that is accessible by the task during execution.listener
- the listener that reacts to change of the execution state.untilTime
- the time until execution of the task must be completed.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task list or one of its task is already running or
if some other error occurs.java.lang.String startTask(java.lang.String listName, java.lang.String taskName) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
listName
- the name of the task list containing the task.taskName
- the name of the task to be executed.SchedulerException
- if the specified task list does not exist or
if the current user has insufficient rights for this operation or
if the task list is already running or
if some other error occurs.java.lang.String startTask(java.lang.String listName, java.lang.String taskName, Metaset metaset) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
listName
- the name of the task list containing the task to be executed.taskName
- the name of the task to be executed.metaset
- the instance of the Metaset (set of key-value pairs) that is accessible by the task during execution.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task list or one of its task is already running or
if some other error occurs.java.lang.String startTask(java.lang.String listName, java.lang.String taskName, Metaset metaset, java.util.Date untilTime) throws SchedulerException
This operation is allowed only if the current user is owner of the task list or has administrator rights.
listName
- the name of the task list containing the task to be executed.taskName
- the name of the task to be executed.metaset
- the instance of the Metaset (set of key-value pairs) that is accessible by the task during execution.untilTime
- the time until execution of the task must be completed.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task list or one of its task is already running or
if some other error occurs.void abortTask(java.lang.String listName, java.lang.String taskName) throws SchedulerException
listName
- the name of the task list containing the task.taskName
- the name of the task to be aborted.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task is not running or
if some other error occurs.void completeTask(java.lang.String listName, java.lang.String taskName) throws SchedulerException
[event.Scheduler.Completion]
).
This method is only applicable for non-autocomplete task lists.
listName
- the name of the task list containing the task.taskName
- the name of the task to be completed.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task is not running or
if some other error occurs.void completeTask(java.lang.String listName, java.lang.String taskName, java.util.Map facets) throws SchedulerException
[event.Scheduler.Completion]
).
This method is only applicable for non-autocomplete task lists.
listName
- the name of the task list containing the task.taskName
- the name of the task to be completed.facets
- the list of name-value pair passed to the task.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task is not running or
if some other error occurs.void completeTask(java.lang.String nodeName, java.lang.String listName, java.lang.String taskName, java.util.Map facets) throws SchedulerException
[event.Scheduler.Completion]
).
This method is only applicable for non-autocomplete task lists.
nodeName
- the name of the node containing the task list.listName
- the name of the task list containing the task.taskName
- the name of the task to be completed.facets
- the list of name-value pair passed to the task.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task is not running or
if some other error occurs.void failTask(java.lang.String listName, java.lang.String taskName) throws SchedulerException
[event.Scheduler.Completion]
)
with the isFailed
parameter set to true
.
This method is only applicable for non-autocomplete task lists.
listName
- the name of the task list containing the task.taskName
- the name of the task to be failed.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task is not running or
if some other error occurs.void failTask(java.lang.String nodeName, java.lang.String listName, java.lang.String taskName) throws SchedulerException
[event.Scheduler.Completion]
)
with the isFailed
parameter set to true
.
This method is only applicable for non-autocomplete task lists.
nodeName
- the name of the node containing the task list.listName
- the name of the task list containing the task.taskName
- the name of the task to be failed.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task is not running or
if some other error occurs.void expireTask(java.lang.String listName, java.lang.String taskName) throws SchedulerException
[event.Scheduler.Completion]
)
with the isExpired
parameter set to true
.
This method is only applicable for non-autocomplete task lists.
listName
- the name of the task list containing the task.taskName
- the name of the task to be completed.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task is not running or
if some other error occurs.void expireTask(java.lang.String nodeName, java.lang.String listName, java.lang.String taskName) throws SchedulerException
[event.Scheduler.Completion]
)
with the isExpired
parameter set to true
.
This method is only applicable for non-autocomplete task lists.
nodeName
- the name of the node containing the task list.listName
- the name of the task list containing the task.taskName
- the name of the task to be completed.SchedulerException
- if the specified task does not exist or
if the current user has insufficient rights for this operation or
if the task is not running or
if some other error occurs.TaskListExecution getExecution(java.lang.String listName, java.util.UUID eid) throws SchedulerException
listName
- the name of the task list.eid
- the execution id.null
if the corresponding execution does not exist.SchedulerException
- if the specified task list does not exist or
if some other error occurs.TaskListExecution getExecution(java.lang.String listName, java.lang.String eid) throws SchedulerException
listName
- the name of the task list.eid
- the string representation of the execution id.null
if the corresponding execution does not exist.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.List getExecutions(java.lang.String listName) throws SchedulerException
listName
- the name of the task list.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.List getExecutions(java.lang.String listName, boolean orderByAsc) throws SchedulerException
listName
- the name of the task list.orderByAsc
- the flag indicating if the result list will be sorted in ASC order.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.List getExecutions(java.lang.String listName, java.util.Date fromTime, java.util.Date toTime) throws SchedulerException
If the parameter fromTime
is null
a list of all executions performed
before the toTime
will be returned (including the boundary).
If the parameter toTime
is null
a list of all executions performed
after the fromTime
will be returned (including the boundary).
If both parameters are null
a list of all executions will be returned.
listName
- the name of the task list.fromTime
- the lower boundary of the time window.toTime
- the upper boundary of the time window.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.List getExecutions(java.lang.String listName, java.util.Date fromTime, java.util.Date toTime, boolean orderByAsc) throws SchedulerException
If the parameter fromTime
is null
a list of all executions performed
before the toTime
will be returned (including the boundary).
If the parameter toTime
is null
a list of all executions performed
after the fromTime
will be returned (including the boundary).
If both parameters are null
a list of all executions will be returned.
listName
- the name of the task list.fromTime
- the lower boundary of the time window.toTime
- the upper boundary of the time window.orderByAsc
- the flag indicating if the result list will be sorted in ASC order.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.List getExecutions(java.lang.String listName, java.util.Date fromTime, java.util.Date toTime, java.lang.String condition) throws SchedulerException
If the parameter fromTime
is null
a list of all executions performed
before the toTime
will be returned (including the boundary).
If the parameter toTime
is null
a list of all executions performed
after the fromTime
will be returned (including the boundary).
If both parameters are null
a list of all executions will be returned.
If the parameter condition
is not null
, the result will be filtered according to this condition.
The condition is applied to each task in the result. It uses the Event Selector syntax and takes the Completion Facets
as a source of its variables. Thus, the result includes only those executions whose tasks have the Completion Facets
that match the specified condition.
listName
- the name of the task list.fromTime
- the lower boundary of the time window.toTime
- the upper boundary of the time window.condition
- the condition that is used for filtering the result executions.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.List getExecutions(java.lang.String listName, java.lang.String condition) throws SchedulerException
If the parameter condition
is not null
, the result will be filtered according to this condition.
The condition is applied to each task in the result. It uses the Event Selector syntax and takes the Completion Facets
as a source of its variables. Thus, the result includes only those executions whose tasks have the Completion Facets
that match the specified condition.
listName
- the name of the task list.condition
- the condition that is used for filtering the result executions.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.Map getAllExecutions(java.util.Date fromTime, java.util.Date toTime) throws SchedulerException
If the parameter fromTime
is null
a list of all executions performed
before the toTime
will be returned (including the boundary).
If the parameter toTime
is null
a list of all executions performed
after the fromTime
will be returned (including the boundary).
If both parameters are null
a list of all executions will be returned.
fromTime
- the lower boundary of the time window.toTime
- the upper boundary of the time window.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.Map getAllExecutions(java.util.Date fromTime, java.util.Date toTime, boolean orderByAsc) throws SchedulerException
If the parameter fromTime
is null
a list of all executions performed
before the toTime
will be returned (including the boundary).
If the parameter toTime
is null
a list of all executions performed
after the fromTime
will be returned (including the boundary).
If both parameters are null
a list of all executions will be returned.
fromTime
- the lower boundary of the time window.toTime
- the upper boundary of the time window.orderByAsc
- the flag indicating if the result list will be sorted in ASC order.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.Map getAllExecutions(java.util.Date fromTime, java.util.Date toTime, java.lang.String condition) throws SchedulerException
If the parameter fromTime
is null
a list of all executions performed
before the toTime
will be returned (including the boundary).
If the parameter toTime
is null
a list of all executions performed
after the fromTime
will be returned (including the boundary).
If both parameters are null
a list of all executions will be returned.
If the parameter condition
is not null
, the result will be filtered according to this condition.
The condition is applied to each task in the result. It uses the Event Selector syntax and takes the Completion Facets
as a source of its variables. Thus, the result includes only those executions whose tasks have the Completion Facets
that match the specified condition.
fromTime
- the lower boundary of the time window.toTime
- the upper boundary of the time window.condition
- the condition that is used for filtering the result executions.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.Map getAllExecutions(java.lang.String condition) throws SchedulerException
If the parameter condition
is not null
, the result will be filtered according to this condition.
The condition is applied to each task in the result. It uses the Event Selector syntax and takes the Completion Facets
as a source of its variables. Thus, the result includes only those executions whose tasks have the Completion Facets
that match the specified condition.
condition
- the condition that is used for filtering the result executions.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.List getExecutions(java.lang.String listName, int fromIndex, int toIndex) throws SchedulerException
fromIndex
(inclusive)
and toIndex
(exclusive).
0
. If the parameters are equal, the returned list is empty.
If the parameter fromIndex
is negative
a list of all executions
before the toIndex
will be returned (excluding the boundary).
If the parameter toIndex
is negative
a list of all executions
after the fromIndex
will be returned (including the boundary).
If both parameters are negative
a list of all executions will be returned.
listName
- the name of the task list.fromIndex
- the lower boundary of the range (inclusive).toIndex
- the upper boundary of the range (exclusive).SchedulerException
- if the specified task list does not exist or
if the fromIndex
is greater than toIndex
or
if some other error occurs.TaskListExecution getLastExecution(java.util.UUID oid)
oid
- the task list id.null
if no execution was found.TaskListExecution getLastExecution(java.lang.String listName) throws SchedulerException
the
- name of the task list.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.List getLastExecutions(java.lang.String listName, int count) throws SchedulerException
If the parameter count
is not positive
the empty list is returned.
listName
- the name of the task list.count
- the number of execution to be returned.SchedulerException
- if the specified task list does not exist or
if some other error occurs.java.util.List getLastExecutions(java.lang.String listName, int count, boolean orderByAsc) throws SchedulerException
If the parameter count
is not positive
the empty list is returned.
listName
- the name of the task list.count
- the number of execution to be returned.orderByAsc
- the flag indicating if the result list will be sorted in ASC order.SchedulerException
- if the specified task list does not exist or
if some other error occurs.int getExecutionsNumber(java.lang.String listName) throws SchedulerException
listName
- the name of the task list.SchedulerException
- if the specified task list does not exist or
if some other error occurs.int getExecutionsNumber(java.lang.String listName, java.util.Date fromTime, java.util.Date toTime) throws SchedulerException
If the parameter fromTime
is null
the number of all executions performed
before the toTime
will be returned (including the boundary).
If the parameter toTime
is null
the number of all executions performed
after the fromTime
will be returned (including the boundary).
If both parameters are null
the number of all executions will be returned.
listName
- the name of the task list.fromTime
- the lower boundary of the time window.toTime
- the upper boundary of the time window.SchedulerException
- if the specified task list does not exist or
if some other error occurs.void purgeExecutions(java.lang.String listName) throws SchedulerException
listName
- the name of the task list.SchedulerException
- if the specified task list does not exist or
if some other error occurs.void purgeExecutions(java.lang.String listName, java.util.Date fromTime, java.util.Date toTime) throws SchedulerException
If the parameter fromTime
is null
all executions performed
before the toTime
will be removed (including the boundary).
If the parameter toTime
is null
all executions performed
after the fromTime
will be removed (including the boundary).
If both parameters are null
all executions will be removed.
listName
- the name of the task list.fromTime
- the lower boundary of the time window.toTime
- the upper boundary of the time window.SchedulerException
- if the specified task list does not exist or
if some other error occurs.SingleJob createSingleJob(java.lang.String name) throws SchedulerException
SingleJob
instance.
So the object returned by this method will not reflect further changes of the corresponding job.
SingleJob
instance the method updateJob(ScheduledJob)
must be used.name
- the name of the job.SchedulerException
- if a job with the specified name already exists or
if some other error occurs.SingleJob createSingleJob(java.lang.String name, java.lang.String sourceName) throws SchedulerException
SingleJob
instance.
So the object returned by this method will not reflect further changes of the corresponding job.
SingleJob
instance the method updateJob(ScheduledJob)
must be used.name
- the name of the job to be created.sourceName
- the name of the source job.SchedulerException
- if a job with the specified name already exists or
if the source job does not exist or
if some other error occurs.SingleJob createSingleJob(java.lang.String name, SingleJob source) throws SchedulerException
SchedulerException
RepeatingJob createRepeatingJob(java.lang.String name) throws SchedulerException
RepeatingJob
instance.
So the object returned by this method will not reflect further changes of the corresponding job.
RepeatingJob
instance the method updateJob(ScheduledJob)
must be used.name
- the name of the job.SchedulerException
- if a job with the specified name already exists or
if some other error occurs.RepeatingJob createRepeatingJob(java.lang.String name, java.lang.String sourceName) throws SchedulerException
RepeatingJob
instance.
So the object returned by this method will not reflect further changes of the corresponding job.
RepeatingJob
instance the method updateJob(ScheduledJob)
must be used.name
- the name of the job to be created.sourceName
- the name of the source job.SchedulerException
- if a job with the specified name already exists or
if the source job does not exist or
if some other error occurs.RepeatingJob createRepeatingJob(java.lang.String name, RepeatingJob source) throws SchedulerException
SchedulerException
ScheduledJob createJob(java.lang.String name, ScheduledJob source) throws SchedulerException
SchedulerException
void dropJob(java.lang.String name) throws SchedulerException
This operation is allowed only if the current user is owner of the job or has administrator rights.
name
- the name of the job.SchedulerException
- if the job is not disabled or
if the current user has insufficient rights for this operation or
if the job is not disabled or
if some other error occurs.void updateJob(ScheduledJob job) throws SchedulerException
ScheduledJob
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 job
by corresponding values of the specified job. After calling this method, any changes of the specified job instance
will have no effect until the next method call.
This operation is allowed only if the current user is owner of the job or has administrator rights.
taskList
- the job to be updated.SchedulerException
- if the specified job does not exist or
if the current user has insufficient rights for this operation or
if the job is not disabled or
if some other error occurs.void setJobOwner(java.lang.String jobName, java.lang.String ownerName) throws SchedulerException
This operation is allowed only if the current user has administrator rights.
listName
- the name of the job.ownerName
- the name of the new owner.SchedulerException
- if the specified job does not exist or
if the specified owner does not exist or
if the current user has insufficient rights for this operation or
if the job is not disabled or
if some other error occurs.void setJobTaskList(java.lang.String jobName, java.lang.String listName) throws SchedulerException
listName
is null
the job cancels the schedule for the currently assigned task list.
This operation is allowed only if the current user is owner of the job and task list or has administrator rights.
jobName
- the job that is scheduled the task list.listName
- the task list to be scheduled.SchedulerException
- if the specified job does not exist or
if the specified owner does not exist or
if the current user has insufficient rights for this operation or
if the job is not disabled or
if some other error occurs.void enableJob(java.lang.String name) throws SchedulerException
This operation is allowed only if the current user is owner of the job or has administrator rights.
name
- the name of the job.SchedulerException
- if the current user has insufficient rights for this operation or
if some other error occurs.void disableJob(java.lang.String name) throws SchedulerException
This operation is allowed only if the current user is owner of the job or has administrator rights.
name
- the name of the job.SchedulerException
- if the specified job does not exist or
if the current user has insufficient rights for this operation or
if the associated task list is currently running or
if some other error occurs.boolean existsJob(java.lang.String name)
name
- the object identifier of the job.true
if the specified job exists, false
otherwise.ScheduledJob getJob(java.lang.String name)
ScheduledJob
instance.
So the object returned by this method will not reflect further changes of the corresponding job.
updateJob(ScheduledJob)
must be used.name
- the name of the job.null
if the corresponding job does not exist.ScheduledJob getJob(java.util.UUID oid)
ScheduledJob
instance.
So the object returned by this method will not reflect further changes of the corresponding job.
updateJob(ScheduledJob)
must be used.name
- the object identifier of the job.null
if the corresponding job does not exist.java.util.List getJobs()
ScheduledJob
instances.
So the objects returned by this method will not reflect further changes of the corresponding jobs.
updateJob(ScheduledJob)
must be used.java.util.List getJobs(java.util.Date time)
ScheduledJob
instances.
So the objects returned by this method will not reflect further changes of the corresponding jobs.
updateJob(ScheduledJob)
must be used.time
- the specified time.java.util.List getJobs(java.util.Date fromTime, java.util.Date toTime)
ScheduledJob
instances.
So the objects returned by this method will not reflect further changes of the corresponding jobs.
updateJob(ScheduledJob)
must be used.
If the parameter fromTime
is null
a list of all jobs scheduled for execution
before the toTime
will be returned (including the boundary).
If the parameter toTime
is null
a list of all jobs scheduled for execution
after the fromTime
will be returned (including the boundary).
If both parameters are null
a list of all jobs will be returned.
fromTime
- the lower boundary of the time window.toTime
- the upper boundary of the time window.java.util.List listJobs()
void purgeJobs()
void purgeJobs(java.util.Date time)
time
- the specified time.void purgeJobs(java.util.Date fromTime, java.util.Date toTime)
If the parameter fromTime
is null
all jobs scheduled for execution
before the toTime
will be removed (including the boundary).
If the parameter toTime
is null
all jobs scheduled for execution
after the fromTime
will be removed (including the boundary).
If both parameters are null
all jobs will be removed.
fromTime
- the lower boundary of the time window.toTime
- the upper boundary of the time window.void addTimeWindow(TimeWindow window) throws SchedulerException
window
- the time window to be added.SchedulerException
- if the specified window is unnamed or
if a time window with the specified name already exists or
if some other error occurs.void removeTimeWindow(java.lang.String name) throws SchedulerException
name
- the name of the time window to be removed.SchedulerException
- if some error occurs.void setTimeWindow(TimeWindow window) throws SchedulerException
window
- the time window to be updated.SchedulerException
- if the specified window is unnamed or
if the specified time window does not exist or
if some other error occurs.boolean existsTimeWindow(java.lang.String name)
name
- the name of the time window to be checked.true
if the specified time window exists, false
otherwise.TimeWindow getTimeWindow(java.lang.String name)
name
- the name of the time window to be searched.null
if the specified time window does not exist.java.util.List getTimeWindows()
java.util.List listTimeWindows()
void addTemplate(TemplateType type, java.lang.String name, java.lang.String value) throws SchedulerException
MacroProcessor
for details).
This operation is allowed only if the current user has administrator rights.
type
- the template type.name
- the template name.value
- the template value.SchedulerException
- if the current user has insufficient rights for this operation or
if the specified template already exists or
if some other error occurs.void removeTemplate(TemplateType type, java.lang.String name) throws SchedulerException
This operation is allowed only if the current user has administrator rights.
type
- the template type.name
- the template name.SchedulerException
- if the current user has insufficient rights for this operation or
if some other error occurs.void setTemplate(TemplateType type, java.lang.String name, java.lang.String value) throws SchedulerException
MacroProcessor
for details).
This operation is allowed only if the current user has administrator rights.
type
- the template type.name
- the template name.value
- the template value.SchedulerException
- if the current user has insufficient rights for this operation or
if the specified template does not exist or
if some other error occurs.java.lang.String getTemplate(TemplateType type, java.lang.String name)
type
- the template type.name
- the template name.null
if this template is not found.boolean existsTemplate(TemplateType type, java.lang.String name)
type
- the template type.name
- the template name.true
if the specified template exists, false
otherwise.java.util.List listTemplates(TemplateType type)
type
- the template type.Metaset createMetaset(java.lang.String name, java.lang.String description, java.util.Map values, boolean isStatic) throws SchedulerException
name
- the metaset name.description
- the metaset description.values
- the predefined values.isStatic
- the flag indicating if the metaset allows adding or removing dynamic keys for its instances.SchedulerException
- if a metaset with the specified name already exists or
if some other error occurs.Metaset updateMetaset(java.lang.String name, java.lang.String description, java.util.Map values, java.lang.Boolean isStatic) throws SchedulerException
null
, this parameter will not be changed.name
- the metaset name.description
- the metaset description.values
- the predefined values.isStatic
- the flag indicating if the metaset allows adding or removing dynamic keys for its instances.SchedulerException
- if a metaset with the specified does not exist or
if some other error occurs.void dropMetaset(java.lang.String name) throws SchedulerException
name
- the metaset name.SchedulerException
- if the current user has insufficient rights for this operation or
if the metaset has associated task lists or
if some other error occurs.boolean existsMetaset(java.lang.String name)
name
- the metaset name.true
if the specified metaset exists, false
otherwise.Metaset getMetaset(java.lang.String name)
Metaset
object.name
- the metaset name.null
if the corresponding metaset does not exist.Metaset getMetaset(java.util.UUID oid)
Metaset
object.name
- the object identifier of the metaset.null
if the corresponding metaset does not exist.java.util.List getMetasets()
Metaset
instances.java.util.List listMetasets()
EventTaskTrigger createTrigger(java.lang.String name) throws SchedulerException
name
- the name of the trigger.SchedulerException
- if a trigger with the specified name already exists or
if some other error occurs.EventTaskTrigger createTrigger(java.lang.String name, java.lang.String sourceName) throws SchedulerException
name
- the name of the trigger to be created.sourceName
- the name of the source trigger.SchedulerException
- if a trigger with the specified name already exists or
if the source trigger does not exist or
if some other error occurs.void dropTrigger(java.lang.String name) throws SchedulerException
name
- the name of the trigger to be dropped.SchedulerException
- if the trigger is not disabled or
if some other error occurs.boolean existsTrigger(java.lang.String name)
name
- the name of the trigger to be checked.true
if the specified trigger exists, false
otherwise.EventTaskTrigger getTrigger(java.lang.String name)
name
- the name of the trigger to be searched.null
if the specified trigger does not exist.java.util.List getTriggers()
java.util.List listTriggers()
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.