public interface ExecutableObject extends SchedulerObject
Title: Service Event Fabric Core
Description: Defines a Scheduler Object that can be executed.
Copyright: Copyright (c) 2019
Company: StreamScape Technologies
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() |
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.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.lang.String |
getMetadata()
Returns a metadata 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.).
|
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 |
setMetadata(java.lang.String metadata)
Sets the specified metadata of the object.
|
void |
setTaskWindow(long taskWindow) |
void |
setTaskWindowUnit(java.util.concurrent.TimeUnit unit) |
getAuthor, getCreationTime, getLastUpdateTime, getOID, getOwner
getDescription, setDescription, setName
getName
void setTaskWindow(long taskWindow)
void setTaskWindowUnit(java.util.concurrent.TimeUnit unit) throws SchedulerException
SchedulerException
void enableResumptionOn(TaskState state) throws SchedulerException
SchedulerException
void enableResumptionTotally() throws SchedulerException
SchedulerException
void disableResumptionOn(TaskState state) throws SchedulerException
SchedulerException
void disableResumptionTotally() throws SchedulerException
SchedulerException
void putProperty(java.lang.String name, java.lang.Object value) throws SchedulerException
The following value types are supported:
name
- the property name.value
- the property value.SchedulerException
- if the specified value has invalid type or
if the operation is not supported.void removeProperty(java.lang.String name) throws SchedulerException
name
- the property name.SchedulerException
- if the operation is not supported.void clearProperties() throws SchedulerException
SchedulerException
- if the operation is not supported.java.lang.Object existsProperty(java.lang.String name)
name
- the property name.true
if the specified property exists, false
otherwise.java.lang.Object getProperty(java.lang.String name)
name
- the property name.null
if the property is not found.java.lang.Object getPropertyResolved(java.lang.String name)
name
- the property name.null
if the property is not found.java.util.Map getProperties()
java.util.List getPropertyList()
void addTag(java.lang.String tag) throws SchedulerException
tag
- the specified tag.SchedulerException
- if the operation is not supported.void removeTag(java.lang.String tag) throws SchedulerException
tag
- the specified tag.SchedulerException
- if the operation is not supported.void clearTags() throws SchedulerException
SchedulerException
- if the operation is not supported.boolean existsTag(java.lang.String tag)
tag
- the specified tag.true
if the specified tag exists, false
otherwise.java.util.List listTags()
java.lang.String getMetadata()
void setMetadata(java.lang.String metadata) throws SchedulerException
metadata
- the metadata to be set.SchedulerException
- if the operation is not supported.java.lang.Long getEndTimeMsec()
-1
if the execution has no time limit.
null
if the object is not currently running.java.util.Date getExpirationDate()
null
if the object is not currently running or the execution has no time limit.Copyright © 2015-2024 StreamScape Technologies. All rights reserved.