|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.util.AbstractXmlObject
com.waveset.object.VariableScope
com.waveset.object.WFCase.Result
A class used to maintain information about the results of an execution of an Actions within an Activity.
One of these will be created for each Action defined in the Activity, both automatic and manual. For automatic actions, we simply record any action variables that the application decided to leave behind. For manual actions, we track the state of the user interaction.
A Result may contain a nested collection of Result objects if the corresponding Action used an iterator.
These will be constructed and installed on the Step object by the WorkflowExecutor. There isn't much validation going on here, we're assuming WorkflowExecutor will do the right thing. Applications are never allowed to mess with this.
Field Summary |
Fields inherited from class com.waveset.object.VariableScope |
code_id |
Fields inherited from class com.waveset.util.AbstractXmlObject |
_trace |
Constructor Summary | |
WFCase.Result()
Build an empty result object. |
|
WFCase.Result(org.w3c.dom.Element e)
Build a result object from XML. |
Method Summary | |
WFCase.Result |
addIterationResult()
Add a new result object to the list. |
WFProcess.Action |
getAction()
Get the resolved action object. |
int |
getActionId()
Get the action id. |
java.lang.Object |
getArgument(java.lang.String name)
Get the value of one argument. |
java.util.Map |
getArguments()
Get the entire collection of action arguments. |
java.lang.String |
getElementName()
Return the element name. |
int |
getIndex()
|
WFCase.Result |
getItemResult(java.lang.String itemId)
Locate the Result object that tracks the state of a particular work item. |
WFCase.Result |
getIterationResult(int index)
Get a single iteration result. |
int |
getIterationResultCount()
Get the number of iteration results. |
java.util.List |
getIterationResults()
Get the nested results array. |
java.lang.Object |
getIterationValue(java.lang.String srcname)
|
java.lang.Object |
getLocalVariable(java.lang.String name)
Return the value of a variable defined in this scope. |
java.lang.String |
getName()
Get a string describing this result. |
java.lang.String |
getOwner()
Get the work item owner. |
WFCase.Result |
getParent()
Get the parent result. |
VariableScope |
getParentScope()
Return the parent scope. |
WFCase.Step |
getStep()
Get the parent step. |
WFCase |
getSubCase()
Get the subcase. |
java.util.Date |
getTimeout()
|
java.lang.String |
getTitle()
Get the report title |
WorkItem |
getWorkItem()
Get the attached work item. |
java.lang.String |
getWorkItemId()
Get the work item id. |
boolean |
isComplete()
Test the completion flag. |
boolean |
isItemResultsPending()
Test the work item pending results flag. |
boolean |
isVariableDefined(java.lang.String name)
Test to see if a variable with a given name is defined in the scope of the result/action. |
protected void |
setAction(WFProcess.Action act)
Set the resolved action object if we happen to know it. |
void |
setActionId(int id)
Set the action id. |
void |
setArgument(java.lang.String name,
java.lang.Object value)
This should only be called by the executor as it sets up arguments. |
void |
setArguments(java.util.Map args)
Set all arguments. |
void |
setComplete(boolean b)
Set the completion flag. |
void |
setIndex(int i)
|
void |
setItemResultsPending(boolean b)
Set the pending item results flag. |
void |
setOwner(java.lang.String owner)
Set the work item owner. |
protected void |
setParent(WFCase.Result res)
Set the parent result. |
protected void |
setStep(WFCase.Step s)
Set the parent step. |
void |
setSubCase(WFCase c)
Set the subcase. |
void |
setTimeout(java.util.Date d)
|
void |
setTitle(java.lang.String s)
Set the report title |
void |
setWorkItem(WorkItem item)
Set the attached work item. |
void |
setWorkItemId(java.lang.String id)
Set the work item id. |
void |
toXml(java.lang.StringBuffer b,
int indent)
Serialize into a buffer with optional indentation. |
Methods inherited from class com.waveset.object.VariableScope |
assimilateLocalVariables, clearLocalVariables, expandVariables, getLocalVariables, getVariable, getVariables, getVariables, pruneGenericObjects, removeLocalVariable, resolveVariable, setLocalVariable, setLocalVariables, setVariable |
Methods inherited from class com.waveset.util.AbstractXmlObject |
addXmlHeader, cloneObject, dump, dumpFile, getReference, println, setTrace, toIdentityString, toVerboseString, toVerboseString, toXml, toXml, toXml |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public WFCase.Result()
public WFCase.Result(org.w3c.dom.Element e) throws WavesetException
Method Detail |
public java.lang.String getElementName()
AbstractXmlObject
getElementName
in interface XmlObject
getElementName
in class AbstractXmlObject
public java.lang.String getName()
public WFCase.Step getStep()
protected void setStep(WFCase.Step s)
public WFCase.Result getParent()
protected void setParent(WFCase.Result res)
public int getActionId()
public void setActionId(int id)
public WFProcess.Action getAction() throws WavesetException
WavesetException
protected void setAction(WFProcess.Action act)
public boolean isComplete()
public java.lang.String getTitle()
public void setTitle(java.lang.String s)
public void setComplete(boolean b)
public java.lang.String getWorkItemId()
public void setWorkItemId(java.lang.String id)
public java.lang.String getOwner()
public void setOwner(java.lang.String owner)
public WorkItem getWorkItem()
public void setWorkItem(WorkItem item)
public boolean isItemResultsPending()
public void setItemResultsPending(boolean b)
public WFCase getSubCase()
public void setSubCase(WFCase c)
public java.util.Map getArguments()
public void setArgument(java.lang.String name, java.lang.Object value)
public void setArguments(java.util.Map args)
public java.lang.Object getArgument(java.lang.String name)
public WFCase.Result getItemResult(java.lang.String itemId)
This may be us, or one of our nested results. And in extreme cases, we may reference a nested case.
public java.util.Date getTimeout()
public void setTimeout(java.util.Date d)
public void setIndex(int i)
public int getIndex()
public VariableScope getParentScope()
VariableScope
getParentScope
in class VariableScope
public boolean isVariableDefined(java.lang.String name) throws WavesetException
This is more complicated than others, because we have to pretend that the iteration variable defined in an Iterate statement is like a variable declaration for the scope.
isVariableDefined
in class VariableScope
WavesetException
public java.lang.Object getLocalVariable(java.lang.String name)
getLocalVariable
in class VariableScope
public java.lang.Object getIterationValue(java.lang.String srcname) throws WavesetException
WavesetException
public java.util.List getIterationResults()
public int getIterationResultCount()
public WFCase.Result getIterationResult(int index)
public WFCase.Result addIterationResult() throws WavesetException
WavesetException
public void toXml(java.lang.StringBuffer b, int indent)
AbstractXmlObject
toXml
in interface XmlObject
toXml
in class AbstractXmlObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |