public interface ScheduledJob extends SchedulerObject
Title: Service Event Fabric Core
Description: Base interface for all jobs managed by the Scheduler.
TaskList
) at a certain time (or periodically with a certain interval).
Supported job types are the following:
SingleJob
)RepeatingJob
)Copyright: Copyright (c) 2013
Company: StreamScape Technologies
Modifier and Type | Method and Description |
---|---|
Metaset |
getExecutionMetaset()
Returns a copy of the Metaset instance that is passed to executed task list.
|
java.util.Date |
getLastExecutionTime()
Returns a time of a last execution of the associated task list.
|
java.util.Date |
getNextExecutionTime()
Returns a time of a next execution of the associated task list.
|
java.lang.String |
getNotifyBody()
Returns the 'body' parameter of the email notifications.
|
java.lang.String |
getNotifyBodyResolved()
Returns the 'body' parameter of the email notifications with resolved macro substitutions (templates, global variables etc).
|
NotifyLevel |
getNotifyLevel()
Returns a level of the email notifications.
|
java.lang.String |
getNotifySubject()
Returns the 'subject' parameter of the email notifications.
|
java.lang.String |
getNotifySubjectResolved()
Returns the 'subject' parameter of the email notifications with resolved macro substitutions (templates, global variables etc).
|
java.lang.String |
getNotifyTo()
Returns the 'to' parameter of the email notifications.
|
java.lang.String |
getNotifyToResolved()
Returns the 'to' parameter of the email notifications with resolved macro substitutions (templates, global variables etc).
|
java.util.Date |
getStartTime()
Returns a time at which the job will start execution of the associated task list.
|
JobState |
getState()
Returns a state of the job.
|
TaskList |
getTaskList()
Returns the task list that is executed by the job.
|
java.lang.String |
getTaskListName()
Returns a name of the task list that is executed by the job.
|
java.util.UUID |
getTaskListOID()
Returns a unique identifier of the task list that is executed by the job.
|
JobType |
getType()
Returns a type of the job.
|
boolean |
hasExecutionMetaset()
Checks if an execution Metaset instance is assigned to the job.
|
boolean |
isNotify()
Checks if the email notifications are enabled.
|
void |
setExecutionMetaset(Metaset metaset)
Sets a copy of the specified Metaset instance that will be passed to executed task list.
|
void |
setNotify(boolean notify)
Sets a parameter specifying if the email notifications are enabled.
|
void |
setNotifyBody(java.lang.String body)
Sets the specified 'body' parameter of email notifications.
|
void |
setNotifyLevel(NotifyLevel level)
Sets the specified level of the email notifications.
|
void |
setNotifySubject(java.lang.String subject)
Sets the specified 'subject' parameter of email notifications.
|
void |
setNotifyTo(java.lang.String to)
Sets the specified 'to' parameter of email notifications.
|
void |
setStartTime(java.util.Date startTime)
Sets a time at which the job will execute the associated task.
|
getAuthor, getCreationTime, getLastUpdateTime, getOID, getOwner
getDescription, setDescription, setName
getName
JobType getType()
java.util.Date getStartTime()
RepeatingJob
or RepeatingGroupJob
) it is a time of a first repeat.java.util.Date getNextExecutionTime()
java.util.Date getLastExecutionTime()
void setStartTime(java.util.Date startTime) throws SchedulerException
RepeatingJob
or RepeatingGroupJob
) it is a time of a first repeat.startTime
- the time of task execution.SchedulerException
- if the job is enabled or finished.java.util.UUID getTaskListOID()
java.lang.String getTaskListName()
This method MUST NOT be used if the task is deserialized from any format (for example, on the remote side).
Use getTaskListOID()
instead.
TaskList getTaskList()
This method MUST NOT be used if the task is deserialized from any format (for example, on the remote side).
boolean isNotify()
Mail Event
for each
Scheduler Advisory
sent.true
if the email notifications are enabled, false
otherwise.void setNotify(boolean notify) throws SchedulerException
notify
- true
if the email notifications are enabled, false
otherwise.SchedulerException
- if the job is enabled or finished.NotifyLevel getNotifyLevel()
void setNotifyLevel(NotifyLevel level) throws SchedulerException
level
- the level to be set.SchedulerException
- if the job is enabled or finished.java.lang.String getNotifyTo()
java.lang.String getNotifyToResolved()
void setNotifyTo(java.lang.String to) throws SchedulerException
$t:{<TemplateName>}
,
global variables, etc).
to
- the value to be set.SchedulerException
- if the job is enabled or finished.java.lang.String getNotifySubject()
java.lang.String getNotifySubjectResolved()
void setNotifySubject(java.lang.String subject) throws SchedulerException
$t:{<TemplateName>}
,
global variables, etc).subject
- the value to be set.SchedulerException
- if the job is enabled or finished.java.lang.String getNotifyBody()
java.lang.String getNotifyBodyResolved()
void setNotifyBody(java.lang.String body) throws SchedulerException
$t:{<TemplateName>}
,
global variables, etc).body
- the value to be set.SchedulerException
- if the job is enabled or finished.boolean hasExecutionMetaset()
true
if the execution Metaset instance is assigned to the job, false
otherwise.Metaset getExecutionMetaset()
void setExecutionMetaset(Metaset metaset) throws SchedulerException
metaset
- the specified Metaset instance to be set.SchedulerException
- if the job has not associated task list or
if the specified Metaset instance does not match the Metaset of the associated task list.JobState getState()
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.