|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.object.PersistentObject
com.waveset.object.TaskDefinition
A class that represents a generic background task definition. Instances of these are created to represent the "types" of tasks that may be launched. A launched instance of this task definition is represented as a TaskInstance object.
Nested Class Summary | |
static class |
TaskDefinition.ExecMode
An enumeration class Used for values of the _execMode field. |
Nested classes inherited from class com.waveset.object.PersistentObject |
PersistentObject.Comparator, PersistentObject.InitialInstance |
Field Summary | |
static java.lang.String |
ATT_FORMATTER
|
static java.lang.String |
ATT_PROGRESS_INTERVAL
|
static java.lang.String |
ATT_QUOTANAME
|
static java.lang.String |
ATT_REPORTS_PROGRESS
|
static java.lang.String |
ATT_RESULTOP
|
static java.lang.String |
code_id
|
static java.lang.String |
ELEMENT
The XML element name used for this type and all subtypes. |
static java.lang.String |
TASK_TYPE_BULK
Task type name used for bulk account operations |
static java.lang.String |
TASK_TYPE_DEFERRED_TASK_SCANNER
Task type name used for deferred task scanners. |
static java.lang.String |
TASK_TYPE_EXTRACT
Task type name used for extraction. |
static java.lang.String |
TASK_TYPE_IMPORT
Task type name used for loading. |
static java.lang.String |
TASK_TYPE_LOAD
Task type name used for loading. |
static java.lang.String |
TASK_TYPE_MAINTENANCE
Task type name used for account maintenance. |
static java.lang.String |
TASK_TYPE_RECONCILE
Task type name used for reconciliation. |
static java.lang.String |
TASK_TYPE_REPORT
Task type name used for reports. |
static java.lang.String |
TASK_TYPE_SCANNER
Task type name used for Risk Analysis. |
static java.lang.String |
TASK_TYPE_SOURCE_ADAPTER
Task type name used for Source adapters. |
static java.lang.String |
TASK_TYPE_SYNCHRONIZER
Task type name used for synchronizers. |
static java.lang.String |
TASK_TYPE_TASK_CONFIGURATION
Task type name used for task configuration. |
static java.lang.String |
TASK_TYPE_WORKFLOW
Task type name used for workflow cases. |
static java.lang.String |
VISIBILITY_ALL
|
static java.lang.String |
VISIBILITY_INVISIBLE
Visibility constants. |
static java.lang.String |
VISIBILITY_RUN
|
static java.lang.String |
VISIBILITY_SCHEDULE
|
Fields inherited from class com.waveset.object.PersistentObject |
_trace, trace |
Constructor Summary | |
TaskDefinition()
Noarg constructor primarily for getInitialInstances. |
|
TaskDefinition(org.w3c.dom.Element e)
Constructor to deserialize from an DOM node. |
Method Summary | |
protected void |
addSubclassAttributes(java.lang.StringBuffer b)
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). |
protected void |
addSubclassElements(java.lang.StringBuffer b)
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). |
protected WSAttribute |
getAttributeValues(java.lang.String attrName)
|
java.lang.String |
getDescription()
Get the description string. |
java.lang.String |
getElementName()
The element name will always be TaskDefinition, even though there may be several types. |
TaskDefinition.ExecMode |
getExecMode()
Get the default execution mode. |
int |
getExecutionLimit()
Get the limit in seconds that the task is allowed to execute. |
void |
getExecutionLimit(int i)
Deprecated. - Use instead #setExecutionLimit(int). Bug#14437. |
java.lang.String |
getExecutor()
Get the name of the class that executes this task. |
XmlObject |
getExtension()
Get the definition extension. |
Form |
getForm()
Get the form object which describes requried and optional initialization data for the task. |
java.util.List |
getHosts()
|
int |
getProgressInterval()
Get the interval in milliseconds that the task applet should check for progress updates. |
java.lang.String |
getQuotaName()
|
java.lang.String |
getResultFormatter()
|
int |
getResultLimit()
Get the limit in seconds that a task instance is allowed to live after the task has completed. |
TaskSchedule.ResultOption |
getResultOption()
Get the result option. |
java.lang.String |
getTaskType()
Get the task type name. |
Type |
getType()
Return the type of this object. |
static java.lang.String |
getTypeDisplayNameKey(java.lang.String name)
|
java.lang.String |
getVisibility()
|
boolean |
isRestartable()
|
boolean |
isSingleton()
Test a flag indicating if the task can be suspended and resumed. |
boolean |
isSuspendable()
Test a flag indicating if the task can be suspended and resumed. |
boolean |
isSyncControlAllowed()
Test a flag indicating if the synchronous execution of the task can be requested by the user. |
boolean |
isSyncExecution()
Test a flag indicating if the default execution mode is synchronous. |
java.util.List |
listExtendedResultTypes()
|
java.util.List |
listQueryableAttributes()
|
java.util.List |
listSummaryAttributes()
Returns the complete list of defined attributes
that this type of persistent object exposes as summary attributes
(regardless of whether this particular object has a value for each). |
protected void |
parseSubclassAttributes(org.w3c.dom.Element e)
Each concrete subclass should parse from the XML buffer any persisted subclass-specific fields (generally, the same ones that it writes into the buffer). |
protected void |
parseSubclassElements(org.w3c.dom.Element e)
Each concrete subclass should parse from the XML buffer any persisted subclass-specific elements (generally, the same ones that it writes into the buffer). |
boolean |
reportsProgress()
Test a flag indicating if the task will be reporting progress during execution. |
boolean |
requiresExecutorDelete()
|
void |
setDescription(java.lang.String s)
Set the description string. |
void |
setExecMode(TaskDefinition.ExecMode mode)
Change the execution mode. |
void |
setExecutionLimit(int i)
Set the limit in seconds that the task is allowed to execute. |
void |
setExecutor(java.lang.String name)
Set the name of the class that executes this class. |
void |
setExtendedResultTypes(java.util.List types)
|
void |
setExtension(XmlObject obj)
Set the definition extension. |
void |
setForm(Form f)
Get the form object which describes requried and optional initialization data for the task. |
void |
setHosts(java.util.List l)
|
void |
setProgressInterval(int l)
Set the interval in milliseconds tha the task status applet should check for progress updates. |
void |
setQuotaName(java.lang.String s)
Get the quota name. |
void |
setReportsProgress(boolean b)
Set a flag indicating if the task will be reporting progress as it executes. |
void |
setRestartable(boolean b)
|
void |
setResultFormatter(java.lang.String s)
|
void |
setResultLimit(int l)
Set the limit in seconds that a task instance is allowed to live after the task has completed. |
void |
setResultOption(TaskSchedule.ResultOption o)
Set the result option. |
void |
setSingleton(boolean b)
Set a flag indicating if the task can be suspended and resumed. |
void |
setSuspendable(boolean b)
Set a flag indicating if the task can be suspended and resumed. |
void |
setSyncControlAllowed(boolean b)
Set a flag indicating if the task can be suspended and resumed. |
void |
setTaskType(java.lang.String name)
Set the task type name. |
void |
setType(Type t)
This is exposed so we can implement a "change type" database upgrade operation. |
void |
setVisibility(java.lang.String s)
|
void |
visit(Visitor v)
Visitor interface. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String code_id
public static final java.lang.String ELEMENT
public static final java.lang.String TASK_TYPE_WORKFLOW
public static final java.lang.String TASK_TYPE_REPORT
public static final java.lang.String TASK_TYPE_MAINTENANCE
public static final java.lang.String TASK_TYPE_SCANNER
public static final java.lang.String TASK_TYPE_EXTRACT
public static final java.lang.String TASK_TYPE_IMPORT
public static final java.lang.String TASK_TYPE_LOAD
public static final java.lang.String TASK_TYPE_BULK
public static final java.lang.String TASK_TYPE_RECONCILE
public static final java.lang.String TASK_TYPE_SOURCE_ADAPTER
public static final java.lang.String TASK_TYPE_DEFERRED_TASK_SCANNER
public static final java.lang.String TASK_TYPE_SYNCHRONIZER
public static final java.lang.String TASK_TYPE_TASK_CONFIGURATION
public static final java.lang.String VISIBILITY_INVISIBLE
public static final java.lang.String VISIBILITY_RUN
public static final java.lang.String VISIBILITY_SCHEDULE
public static final java.lang.String VISIBILITY_ALL
public static final java.lang.String ATT_RESULTOP
public static final java.lang.String ATT_QUOTANAME
public static final java.lang.String ATT_REPORTS_PROGRESS
public static final java.lang.String ATT_PROGRESS_INTERVAL
public static final java.lang.String ATT_FORMATTER
Constructor Detail |
public TaskDefinition()
public TaskDefinition(org.w3c.dom.Element e) throws WavesetException
Method Detail |
public java.util.List listExtendedResultTypes()
PersistentObject type
.
Each associated sub-object will expose
a queryable attribute (Attribute.TASKID)
with a value matching the id of the "parent" task instance.public void setExtendedResultTypes(java.util.List types)
public boolean requiresExecutorDelete()
true
if the Executor class must be invoked
in order to clean up state associated with a task instance that:
extended result types
;
public Type getType()
PersistentObject
getType
in class PersistentObject
public java.lang.String getElementName()
getElementName
in interface XmlObject
getElementName
in class PersistentObject
public void setType(Type t)
public void visit(Visitor v) throws WavesetException
visit
in class PersistentObject
WavesetException
public java.lang.String getTaskType()
TASK_TYPE_REPORT
,
TASK_TYPE_MAINTENANCE
,
TASK_TYPE_WORKFLOW
public void setTaskType(java.lang.String name)
TASK_TYPE_REPORT
,
TASK_TYPE_MAINTENANCE
,
TASK_TYPE_WORKFLOW
public java.lang.String getExecutor()
public void setExecutor(java.lang.String name)
public Form getForm()
public void setForm(Form f)
public boolean isSuspendable()
public void setSuspendable(boolean b)
public boolean isSyncControlAllowed()
public void setSyncControlAllowed(boolean b)
public TaskDefinition.ExecMode getExecMode()
public void setExecMode(TaskDefinition.ExecMode mode)
public boolean isSyncExecution()
public boolean isSingleton()
public void setSingleton(boolean b)
public int getExecutionLimit()
public void getExecutionLimit(int i)
public void setExecutionLimit(int i)
public int getResultLimit()
public TaskSchedule.ResultOption getResultOption()
public void setResultOption(TaskSchedule.ResultOption o)
public void setResultLimit(int l)
public XmlObject getExtension()
public void setExtension(XmlObject obj)
public java.lang.String getDescription()
public void setDescription(java.lang.String s)
public void setQuotaName(java.lang.String s)
public java.lang.String getQuotaName()
public void setVisibility(java.lang.String s)
public java.lang.String getVisibility()
public boolean reportsProgress()
public void setReportsProgress(boolean b)
public int getProgressInterval()
public void setProgressInterval(int l)
public java.util.List getHosts()
public void setHosts(java.util.List l)
public java.lang.String getResultFormatter()
public void setResultFormatter(java.lang.String s)
public void setRestartable(boolean b)
public boolean isRestartable()
public java.util.List listQueryableAttributes()
listQueryableAttributes
in class PersistentObject
defined attributes
that this type of PersistentObject exposes as queryable attributes
(regardless of whether this object has a value for each).
Any subclass of PersistentObject that overrides this method
should first invoke super.getQueryableAttributes()
to ensure that the subclass includes queryable attributes
that are common to all PersistentObjects.public java.util.List listSummaryAttributes()
PersistentObject
defined attributes
that this type of persistent object exposes as summary attributes
(regardless of whether this particular object has a value for each).
Any subclass of PersistentObject that overrides this method
should first invoke super.listSummaryAttributes()
to ensure that the subclass includes summary attributes
that are common to all PersistentObjects.
Any subclass that overrides this implementation must also consider the length of the summary string that will be generated from these attributes.
listSummaryAttributes
in class PersistentObject
defined attributes
that this type of PersistentObject exposes as summary attributes
(regardless of whether this object has a value for each).
Any subclass of PersistentObject that overrides this method
should first invoke super.listSummaryAttributes()
to ensure that the subclass includes summary attributes
that are common to all PersistentObjects.Constants.MAX_SUMMARY_STRING_LENGTH
,
PersistentObject.getSummaryString()
protected WSAttribute getAttributeValues(java.lang.String attrName)
getAttributeValues
in class PersistentObject
attrName
- - the name of the attribute for which to return values.
WSAttribute
that represents the value (or values)
that this object contains for the specified attribute.protected void addSubclassAttributes(java.lang.StringBuffer b)
PersistentObject
NOTE: Any subclass that overrides this method must similarly override parseSubclassAttributes() so that the subclass attributes are restored.
addSubclassAttributes
in class PersistentObject
protected void addSubclassElements(java.lang.StringBuffer b)
PersistentObject
NOTE: Any subclass that overrides this method must similarly override parseSubclassElements() so that the subclass elements are restored.
addSubclassElements
in class PersistentObject
protected void parseSubclassAttributes(org.w3c.dom.Element e) throws WavesetException
PersistentObject
parseSubclassAttributes
in class PersistentObject
WavesetException
PersistentObject's default implementation is a no-op.
,
PersistentObject.parseXml(Element)
protected void parseSubclassElements(org.w3c.dom.Element e) throws WavesetException
PersistentObject
parseSubclassElements
in class PersistentObject
WavesetException
PersistentObject's default implementation is a no-op.
,
PersistentObject.parseXml(Element)
public static java.lang.String getTypeDisplayNameKey(java.lang.String name)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |