|
||||||||||
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.TaskResult
This class represents the result of an individual operation within the execution of a larger task.
Previously, a TaskInstance contained its entire WavesetResult. However, this made the task instance large, and this meant that the entire (increasingly large) task instance had to be serialized and re-written into the repository in order to add and persist another individual result. By separating the result from the task, and by separating each item of the result, we can make it easier to incrementally update (and to incrementally display) large results.
An instance ordinarily contains a WavesetResult
object.
Nested Class Summary |
Nested classes inherited from class com.waveset.object.PersistentObject |
PersistentObject.Comparator, PersistentObject.InitialInstance |
Field Summary | |
static java.lang.String |
code_id
|
static java.lang.String |
EL_TASKREF
|
static java.lang.String |
FROM_SEQUENCE
Option key to specify the start of a sequence number range. |
static java.lang.String |
JUST_LIST_THEM
Option key to specify the end of a sequence number range. |
static java.lang.String |
TO_SEQUENCE
Option key to specify the end of a sequence number range. |
Fields inherited from class com.waveset.object.PersistentObject |
_trace, trace |
Constructor Summary | |
TaskResult()
Create an empty task result, ready to be filled. |
|
TaskResult(org.w3c.dom.Element e)
Build a work item from its XML representation. |
|
TaskResult(TaskInstance task)
Build a result for one part of a task. |
|
TaskResult(TaskInstance task,
int sequence)
Build a result for one part of a task. |
Method Summary | |
protected void |
addSubclassAttributes(java.lang.StringBuffer buf)
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 buf)
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). |
static AttributeCondition[] |
forTask(java.lang.String taskId)
|
static AttributeCondition[] |
forTask(TaskInstance ti)
|
protected WSAttribute |
getAttributeValues(java.lang.String attrName)
|
static java.lang.String |
getName(java.lang.String taskId,
int sequence)
|
static java.lang.String |
getName(TaskInstance task,
int sequence)
|
static java.lang.String |
getNameBase(java.lang.String taskId)
|
static java.lang.String |
getParentTaskId(java.lang.String taskResultName)
|
WavesetResult |
getResult()
|
int |
getSequence()
|
TaskInstance |
getTask()
Get the resolved TaskInstance to which this result belongs. |
ObjectRef |
getTaskRef()
Get a reference to the TaskInstance that contains our WorkflowCase. |
Type |
getType()
Returns the associated Type object. |
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). |
void |
setResult(WavesetResult result)
Embed a WavesetResult in this extended result. |
void |
setSequence(int sequence)
Set the sequence number for this extended result. |
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 FROM_SEQUENCE
public static final java.lang.String TO_SEQUENCE
public static final java.lang.String JUST_LIST_THEM
public static final java.lang.String EL_TASKREF
Constructor Detail |
public TaskResult()
public TaskResult(TaskInstance task)
public TaskResult(TaskInstance task, int sequence)
public TaskResult(org.w3c.dom.Element e) throws WavesetException
Method Detail |
public Type getType()
getType
in class PersistentObject
public ObjectRef getTaskRef()
public TaskInstance getTask() throws WavesetException
WavesetException
public void setSequence(int sequence)
This mutator allows the same TaskResult
object
to be re-used.
public int getSequence()
public void setResult(WavesetResult result)
WavesetResult
in this extended result.
This allows the same TaskResult
object
to be re-used.
public WavesetResult getResult()
WavesetResult
from this extended result.public static java.lang.String getName(TaskInstance task, int sequence)
public static java.lang.String getName(java.lang.String taskId, int sequence)
public static java.lang.String getNameBase(java.lang.String taskId)
public static java.lang.String getParentTaskId(java.lang.String taskResultName) throws InvalidArgument
null
if it cannot parse
an id from the task result name.
In effect, an inverse of getName()
.
InvalidArgument
getName(String,int)
public static AttributeCondition[] forTask(TaskInstance ti)
public static AttributeCondition[] forTask(java.lang.String taskId)
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 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.
Constants.MAX_SUMMARY_STRING_LENGTH
,
PersistentObject.getSummaryString()
public java.util.List listQueryableAttributes()
listQueryableAttributes
in class PersistentObject
defined attributes
that this type of persistent object exposes as queryable attributes
(regardless of whether this particular object has a value for each).
Any subclass of PersistentObject that overrides this method
should first invoke super.listQueryableAttributes()
to ensure that the subclass includes queryable attributes
that are common to all PersistentObjects.
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 buf)
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 buf)
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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |