|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaskPlan
Represents metadata common to a set of tasks. The task plan defines a set of steps through which all tasks of this type will pass. Each step defines a number of actions which may be taken by a human user in order to cause a task to progress to a subsequent step.
Nested Class Summary | |
---|---|
static interface |
TaskPlan.Event
Property names for the PropertyChangeEvents that can be produced by edits on a object of this type. |
Method Summary | |
---|---|
BusinessDateTime |
createCompletionDueBusinessDate()
Create and set the completion due business date for tasks of this type. |
TaskOwnerDefinition |
createOwnerDefinition()
Create and set a blank definition for how the owner for tasks of this type will be calculated. |
RuleBindings |
createRuleBindings()
|
Interval |
createTerminalTaskRetentionTime()
Create and set the amount of time tasks of this type should be retained in the runtime store after they have reached a terminal administrative state (completed or aborted). |
Interval |
createTimeEstimate()
Create and set the Interval instance representing the estimated time it will take to complete this task. |
void |
destroyCompletionDueBusinessDate()
Destroy and unset the completion due business date for this task plan. |
void |
destroyOwnerDefinition()
Destroy and unset the TaskOwnerDefinition for this task plan. |
void |
destroyRuleBindings()
|
void |
destroyTerminalTaskRetentionTime()
Destroy and unset the terminal task retention time for this task plan. |
void |
destroyTimeEstimate()
Destroy and unset the time estimate for this task plan. |
BusinessDateTime |
getCompletionDueBusinessDate()
Business date and time by which this task must be completed. |
ConstructorContainer |
getConstructorContainer()
Get the container that holds all constructors defined for this task plan. |
long |
getDefaultStepTimeEstimateInMinutes()
Get the default time estimate for steps in minutes. |
String |
getDescription()
A description of the purpose for this task plan, or null if none was set. |
String |
getHostApplicationId()
Get the name of the application that hosts this task plan. |
TaskPlanId |
getId()
Get the server-wide unique identifier for this task plan. |
int |
getLoadBalancingAvailabilityCheckThresholdPriority()
An integer value that indicates a threshold task priority, above which availability checking will automatically be enabled. |
TaskOwnerDefinition |
getOwnerDefinition()
Get information about how the owner for tasks of this type will be defined. |
TaskPlanPath |
getPath()
Get a path representing the location of this task plan in an abstract hierarchy. |
Property |
getProperty(String name)
Get a Property by name. |
NamedObjectContainer<Property> |
getPropertyContainer()
Get a reference to the container object that holds properties for this task plan. |
String[] |
getPropertyNames()
An array of names for the user-defined properties defined on this task type. |
RuleBindings |
getRuleBindings()
Get an object representing the bindings of rules to this task plan. |
Step |
getStep(String name)
|
NamedObjectContainer<Step> |
getStepContainer()
Get a reference to the container object that holds steps for this task plan. |
String[] |
getStepNames()
An array of names for the steps defined on this task plan. |
Property[] |
getSystemProperties()
Get all the system defined properties. |
Property |
getSystemProperty(SystemProperty sysProp)
Get a system defined property. |
Interval |
getTerminalTaskRetentionTime()
An amount of time tasks of this type should be retained in the runtime store after they have reached a terminal administrative state (completed or aborted). |
Interval |
getTimeEstimate()
Get the time estimate for this task plan. |
float |
getVersion()
The version of this task plan in major.minor format. |
void |
initializeFromDescriptorStream(InputStream descriptorStream)
Parse the XML content from the given InputStream into this TaskPlan, replacing any state that may exist in this object. |
void |
initializeFromDescriptorStream(InputStream descriptorStream,
ClassLoader loader)
Parse the XML content from the given InputStream into this TaskPlan, replacing any state that may exist in this object, and using the given ClassLoader. |
boolean |
isLayoutManualAllowed()
Is the view allowed to use bounds information to layout the figures in this task plan? This property fires no events. |
boolean |
isLayoutManualDesired()
Should the view try to lay out the figures in this task plan manually with help from the user and stored bounds information? Changing this property fires a LAYOUT event. |
void |
setCompletionDueBusinessDate(BusinessDateTime dateTime)
Set the completion due business date for tasks of this type. |
void |
setDescription(String description)
Set the description for this task plan. |
void |
setLayoutManualAllowed(boolean newValue)
|
void |
setLayoutManualDesired(boolean newValue)
|
void |
setLoadBalancingAvailabilityCheckThresholdPriority(int threshold)
|
void |
setOwnerDefinition(TaskOwnerDefinition owner)
Set the definition for how the owner for tasks of this type will be calculated. |
void |
setPath(TaskPlanPath path)
Set the path to this task plan. |
void |
setTerminalTaskRetentionTime(Interval time)
Set the amount of time tasks of this type should be retained in the runtime store after they have reached a terminal administrative state (completed or aborted). |
void |
setTimeEstimate(Interval estimate)
An estimate of the time it will take to complete this task. |
void |
setVersion(float version)
|
void |
writeToDescriptorStream(OutputStream descriptorStream,
String encoding)
Write this TaskPlan out as XML content into the given OutputStream. |
Methods inherited from interface com.bea.wli.worklist.api.taskplan.EventSource |
---|
addPropertyChangeListener, addPropertyChangeListener, clearDirty, dispose, getParent, isComplete, isDirty, isInitializing, isStarted, markDirty, removePropertyChangeListener, removePropertyChangeListener, startProducing |
Method Detail |
---|
TaskPlanId getId()
TaskPlanPath getPath()
TaskPlanRegistry.getTaskPlansInFolder(com.bea.wli.path.FolderPath)
void setPath(TaskPlanPath path)
path
- The new path to this task plan. Must not be null.float getVersion()
void setVersion(float version)
String getHostApplicationId()
String getDescription()
void setDescription(String description)
description
- BusinessDateTime getCompletionDueBusinessDate()
createCompletionDueBusinessDate()
,
setCompletionDueBusinessDate(BusinessDateTime)
,
destroyCompletionDueBusinessDate()
void setCompletionDueBusinessDate(BusinessDateTime dateTime)
createCompletionDueBusinessDate()
,
TaskPlanFactory.createBusinessDateTime()
BusinessDateTime createCompletionDueBusinessDate()
void destroyCompletionDueBusinessDate()
Interval getTimeEstimate()
setTimeEstimate(Interval estimate)
void setTimeEstimate(Interval estimate)
Instances of Interval may be created via TaskPlanFactory. For most users, you should use createTimeEstimate to take the place of creating the instance and the call to this method.
estimate
- An Interval instance representing the estimated time
needed to complete this task. If no estimate has been set, this
method will return null.createTimeEstimate()
,
destroyTimeEstimate()
,
TaskPlanFactory.createInterval(String)
Interval createTimeEstimate()
getTimeEstimate()
,
destroyTimeEstimate()
void destroyTimeEstimate()
long getDefaultStepTimeEstimateInMinutes()
TaskOwnerDefinition getOwnerDefinition()
setOwnerDefinition(TaskOwnerDefinition)
,
createOwnerDefinition()
,
destroyOwnerDefinition()
void setOwnerDefinition(TaskOwnerDefinition owner)
createOwnerDefinition()
,
TaskPlanFactory.createTaskOwnerDefinition()
TaskOwnerDefinition createOwnerDefinition()
void destroyOwnerDefinition()
int getLoadBalancingAvailabilityCheckThresholdPriority()
void setLoadBalancingAvailabilityCheckThresholdPriority(int threshold)
Interval getTerminalTaskRetentionTime()
createTerminalTaskRetentionTime()
,
setTerminalTaskRetentionTime(Interval)
void setTerminalTaskRetentionTime(Interval time)
createTerminalTaskRetentionTime()
,
TaskPlanFactory.createInterval(String)
Interval createTerminalTaskRetentionTime()
void destroyTerminalTaskRetentionTime()
RuleBindings getRuleBindings()
RuleBindings createRuleBindings()
void destroyRuleBindings()
NamedObjectContainer<Property> getPropertyContainer()
Property[] getSystemProperties()
Property getSystemProperty(SystemProperty sysProp)
String[] getPropertyNames()
Property getProperty(String name) throws UnknownObjectException
UnknownObjectException
ConstructorContainer getConstructorContainer()
NamedObjectContainer<Step> getStepContainer()
String[] getStepNames()
Step getStep(String name) throws UnknownObjectException
UnknownObjectException
void initializeFromDescriptorStream(InputStream descriptorStream) throws ParseException, IOException
descriptorStream
- The InputStream to read from.
ParseException
- If any syntactical or validation error occurs.
IOException
- If any error occurs while reading content from the
InputStream.void initializeFromDescriptorStream(InputStream descriptorStream, ClassLoader loader) throws ParseException, IOException
descriptorStream
- The InputStream to read from.loader
- The ClassLoader to use when finding the binding file
(META-INF/binding-file.ser) the defines the mapping from the XML
in the descriptor to the implementation classes for TaskPlan.
ParseException
- If any syntactical or validation error occurs.
IOException
- If any error occurs while reading content from the
InputStream.void writeToDescriptorStream(OutputStream descriptorStream, String encoding) throws IOException
descriptorStream
- The OutputStream to read from.encoding
- The character encoding (as a valid Java charset name)
to use when generating the XML content for the plan. If null,
a system-defined default encoding is used (though this is not
recommended).
IOException
- If any error occurs while reading content from the
InputStream.boolean isLayoutManualDesired()
void setLayoutManualDesired(boolean newValue)
boolean isLayoutManualAllowed()
void setLayoutManualAllowed(boolean newValue)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |