public class SingleJob extends CloneableDataObject implements ScheduledJob
Title: Service Event Fabric Core
Description: Defines a job that executes the specified task once at the specified time.
Copyright: Copyright (c) 2013
Company: StreamScape Technologies
DEFAULT_SERIAL_VERSION_ID
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object other) |
java.lang.String |
getAuthor()
Returns a name of the user that created this object.
|
java.util.Date |
getCreationTime()
Returns a timestamp indicating when the object was created.
|
java.lang.String |
getDescription()
Returns a description of the object.
|
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 |
getLastUpdateTime()
Returns a timestamp indicating when the object was updated last time.
|
java.lang.String |
getName()
Returns a name of the object.
|
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.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.
|
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 |
setDescription(java.lang.String description)
Sets the specified description of the object.
|
void |
setExecutionMetaset(Metaset metaset)
Sets a copy of the specified Metaset instance that will be passed to executed task list.
|
void |
setName(java.lang.String name)
Sets the specified object name.
|
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.
|
java.lang.String |
toString() |
clone, getSerialVersionUID
getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecutionMetaset, getLastExecutionTime, getNextExecutionTime, getNotifyBody, getNotifyBodyResolved, getNotifyLevel, getNotifySubject, getNotifySubjectResolved, getNotifyTo, getNotifyToResolved, getStartTime, getState, getTaskList, getTaskListName, getTaskListOID, hasExecutionMetaset, isNotify, setExecutionMetaset, setNotify, setNotifyBody, setNotifyLevel, setNotifySubject, setNotifyTo, setStartTime
getAuthor, getCreationTime, getLastUpdateTime, getOID, getOwner
getDescription, setDescription, setName
getName
public JobType getType()
ScheduledJob
getType
in interface ScheduledJob
public java.util.Date getStartTime()
ScheduledJob
RepeatingJob
or RepeatingGroupJob
) it is a time of a first repeat.getStartTime
in interface ScheduledJob
public void setStartTime(java.util.Date startTime) throws SchedulerException
ScheduledJob
RepeatingJob
or RepeatingGroupJob
) it is a time of a first repeat.setStartTime
in interface ScheduledJob
startTime
- the time of task execution.SchedulerException
- if the job is enabled or finished.public java.util.Date getNextExecutionTime()
ScheduledJob
getNextExecutionTime
in interface ScheduledJob
public java.util.Date getLastExecutionTime()
ScheduledJob
getLastExecutionTime
in interface ScheduledJob
public JobState getState()
ScheduledJob
getState
in interface ScheduledJob
public boolean isNotify()
ScheduledJob
Mail Event
for each
Scheduler Advisory
sent.isNotify
in interface ScheduledJob
true
if the email notifications are enabled, false
otherwise.public void setNotify(boolean notify) throws SchedulerException
ScheduledJob
setNotify
in interface ScheduledJob
notify
- true
if the email notifications are enabled, false
otherwise.SchedulerException
- if the job is enabled or finished.public NotifyLevel getNotifyLevel()
ScheduledJob
getNotifyLevel
in interface ScheduledJob
public void setNotifyLevel(NotifyLevel level) throws SchedulerException
ScheduledJob
setNotifyLevel
in interface ScheduledJob
level
- the level to be set.SchedulerException
- if the job is enabled or finished.public java.lang.String getNotifyTo()
ScheduledJob
getNotifyTo
in interface ScheduledJob
public java.lang.String getNotifyToResolved()
ScheduledJob
getNotifyToResolved
in interface ScheduledJob
public void setNotifyTo(java.lang.String to) throws SchedulerException
ScheduledJob
$t:{<TemplateName>}
,
global variables, etc).
setNotifyTo
in interface ScheduledJob
to
- the value to be set.SchedulerException
- if the job is enabled or finished.public java.lang.String getNotifySubject()
ScheduledJob
getNotifySubject
in interface ScheduledJob
public java.lang.String getNotifySubjectResolved()
ScheduledJob
getNotifySubjectResolved
in interface ScheduledJob
public void setNotifySubject(java.lang.String subject) throws SchedulerException
ScheduledJob
$t:{<TemplateName>}
,
global variables, etc).setNotifySubject
in interface ScheduledJob
subject
- the value to be set.SchedulerException
- if the job is enabled or finished.public java.lang.String getNotifyBody()
ScheduledJob
getNotifyBody
in interface ScheduledJob
public java.lang.String getNotifyBodyResolved()
ScheduledJob
getNotifyBodyResolved
in interface ScheduledJob
public void setNotifyBody(java.lang.String body) throws SchedulerException
ScheduledJob
$t:{<TemplateName>}
,
global variables, etc).setNotifyBody
in interface ScheduledJob
body
- the value to be set.SchedulerException
- if the job is enabled or finished.public java.util.UUID getTaskListOID()
ScheduledJob
getTaskListOID
in interface ScheduledJob
public java.lang.String getTaskListName()
ScheduledJob
This method MUST NOT be used if the task is deserialized from any format (for example, on the remote side).
Use ScheduledJob.getTaskListOID()
instead.
getTaskListName
in interface ScheduledJob
public TaskList getTaskList()
ScheduledJob
This method MUST NOT be used if the task is deserialized from any format (for example, on the remote side).
getTaskList
in interface ScheduledJob
public boolean hasExecutionMetaset()
ScheduledJob
hasExecutionMetaset
in interface ScheduledJob
true
if the execution Metaset instance is assigned to the job, false
otherwise.public Metaset getExecutionMetaset()
ScheduledJob
getExecutionMetaset
in interface ScheduledJob
public void setExecutionMetaset(Metaset metaset) throws SchedulerException
ScheduledJob
setExecutionMetaset
in interface ScheduledJob
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.public java.lang.String toString()
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.