public abstract class AbstractExecutableObject extends CloneableDataObject implements ExecutableObject
Title: Service Event Fabric Core
Description: Base class for ScheduledTask
and GroupTask
.
Copyright: Copyright (c) 2013
Company: StreamScape Technologies
DEFAULT_SERIAL_VERSION_ID
Modifier and Type | Method and Description |
---|---|
void |
addTag(java.lang.String tag)
Adds the specified tag.
|
void |
clearProperties()
Removes all properties.
|
void |
clearTags()
Removes all tags.
|
void |
disableResumptionOn(TaskState state) |
void |
disableResumptionTotally() |
void |
enableResumptionOn(TaskState state) |
void |
enableResumptionTotally() |
boolean |
equals(java.lang.Object other) |
java.lang.Object |
existsProperty(java.lang.String name)
Checks if the specified property exists.
|
boolean |
existsTag(java.lang.String tag)
Checks if the specified tag exists.
|
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.
|
java.lang.Long |
getEndTimeMsec()
Returns a time (in milliseconds) until the current execution of the object is completed.
|
java.util.Date |
getExpirationDate()
Returns a date until the current execution of the object is completed.
|
java.util.Date |
getLastUpdateTime()
Returns a timestamp indicating when the object was updated last time.
|
java.lang.String |
getMetadata()
Returns a metadata of the object.
|
java.lang.String |
getName()
Returns a name of the object.
|
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.Map |
getProperties()
Returns a map of all properties.
|
java.lang.Object |
getProperty(java.lang.String name)
Returns a value of the specified property.
|
java.util.List |
getPropertyList()
Returns a list of all properties with their values.
|
java.lang.Object |
getPropertyResolved(java.lang.String name)
Returns a value of the specified property with resolved macro substitutions (global variables etc.).
|
boolean |
isAutoComplete() |
java.util.List |
listProperties() |
java.util.List |
listTags()
Returns a list of all tags.
|
void |
putProperty(java.lang.String name,
java.lang.Object value)
Puts a new property with the specified name and value.
|
void |
removeProperty(java.lang.String name)
Removes the specified property.
|
void |
removeTag(java.lang.String tag)
Removes the specified tag.
|
void |
setDescription(java.lang.String description)
Sets the specified description of the object.
|
void |
setMetadata(java.lang.String metadata)
Sets the specified metadata of the object.
|
void |
setName(java.lang.String name)
Sets the specified object name.
|
void |
setTaskWindow(long taskWindow) |
void |
setTaskWindowUnit(java.util.concurrent.TimeUnit unit) |
java.lang.String |
toString() |
clone, getSerialVersionUID
getClass, hashCode, notify, notifyAll, wait, wait, wait
getAuthor, getCreationTime, getLastUpdateTime, getOID, getOwner
getDescription, setDescription, setName
getName
public void setTaskWindow(long taskWindow)
setTaskWindow
in interface ExecutableObject
public void setTaskWindowUnit(java.util.concurrent.TimeUnit unit) throws SchedulerException
setTaskWindowUnit
in interface ExecutableObject
SchedulerException
public void enableResumptionOn(TaskState state) throws SchedulerException
enableResumptionOn
in interface ExecutableObject
SchedulerException
public void enableResumptionTotally() throws SchedulerException
enableResumptionTotally
in interface ExecutableObject
SchedulerException
public void disableResumptionOn(TaskState state) throws SchedulerException
disableResumptionOn
in interface ExecutableObject
SchedulerException
public void disableResumptionTotally() throws SchedulerException
disableResumptionTotally
in interface ExecutableObject
SchedulerException
public void putProperty(java.lang.String name, java.lang.Object value) throws SchedulerException
ExecutableObject
The following value types are supported:
putProperty
in interface ExecutableObject
name
- the property name.value
- the property value.SchedulerException
- if the specified value has invalid type or
if the operation is not supported.public void removeProperty(java.lang.String name) throws SchedulerException
ExecutableObject
removeProperty
in interface ExecutableObject
name
- the property name.SchedulerException
- if the operation is not supported.public void clearProperties() throws SchedulerException
ExecutableObject
clearProperties
in interface ExecutableObject
SchedulerException
- if the operation is not supported.public java.lang.Object existsProperty(java.lang.String name)
ExecutableObject
existsProperty
in interface ExecutableObject
name
- the property name.true
if the specified property exists, false
otherwise.public java.lang.Object getProperty(java.lang.String name)
ExecutableObject
getProperty
in interface ExecutableObject
name
- the property name.null
if the property is not found.public java.lang.Object getPropertyResolved(java.lang.String name)
ExecutableObject
getPropertyResolved
in interface ExecutableObject
name
- the property name.null
if the property is not found.public java.util.List listProperties()
public java.util.Map getProperties()
ExecutableObject
getProperties
in interface ExecutableObject
public java.util.List getPropertyList()
ExecutableObject
getPropertyList
in interface ExecutableObject
public void addTag(java.lang.String tag) throws SchedulerException
ExecutableObject
addTag
in interface ExecutableObject
tag
- the specified tag.SchedulerException
- if the operation is not supported.public void removeTag(java.lang.String tag) throws SchedulerException
ExecutableObject
removeTag
in interface ExecutableObject
tag
- the specified tag.SchedulerException
- if the operation is not supported.public void clearTags() throws SchedulerException
ExecutableObject
clearTags
in interface ExecutableObject
SchedulerException
- if the operation is not supported.public boolean existsTag(java.lang.String tag)
ExecutableObject
existsTag
in interface ExecutableObject
tag
- the specified tag.true
if the specified tag exists, false
otherwise.public java.util.List listTags()
ExecutableObject
listTags
in interface ExecutableObject
public boolean isAutoComplete()
public java.lang.String getMetadata()
ExecutableObject
getMetadata
in interface ExecutableObject
public void setMetadata(java.lang.String metadata) throws SchedulerException
ExecutableObject
setMetadata
in interface ExecutableObject
metadata
- the metadata to be set.SchedulerException
- if the operation is not supported.public java.lang.Long getEndTimeMsec()
ExecutableObject
-1
if the execution has no time limit.
null
if the object is not currently running.getEndTimeMsec
in interface ExecutableObject
public java.util.Date getExpirationDate()
ExecutableObject
null
if the object is not currently running or the execution has no time limit.getExpirationDate
in interface ExecutableObject
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 java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.