com.waveset.object
Class TaskResultPage

java.lang.Object
  extended bycom.waveset.object.PersistentObject
      extended bycom.waveset.object.TaskResultPage
All Implemented Interfaces:
java.lang.Comparable, javax.naming.Referenceable, XmlObject

public class TaskResultPage
extends PersistentObject

Stores the HTML of an extended results page (i.e., the serialized XML for a merged WavesetResult representing a range of extended results).

An instance contains an embedded html element.


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_HTML
           
 
Fields inherited from class com.waveset.object.PersistentObject
_trace, trace
 
Constructor Summary
TaskResultPage()
          Create an empty task result, ready to be filled.
TaskResultPage(org.w3c.dom.Element e)
          Deserialize a task result page.
TaskResultPage(java.lang.String taskId, int pageNumber, int fromSeq, int toSeq, java.lang.String html)
          Build a page with HTML representing a range of task extended results.
 
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 parentTaskId)
           
static AttributeCondition[] forTask(TaskInstance ti)
           
protected  WSAttribute getAttributeValues(java.lang.String attrName)
           
 int getFromSequence()
           
 java.lang.String getHTML()
           
static java.lang.String getName(java.lang.String taskId, int pageNumber)
           
static java.lang.String getName(TaskInstance task, int pageNumber)
           
static java.lang.String getNameBase(java.lang.String taskId)
           
 int getPageNumber()
           
 java.lang.String getTaskId()
           
 int getToSequence()
           
 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).
static void main(java.lang.String[] args)
           
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 setFromSequence(int fromSeq)
           
 void setHTML(java.lang.String html)
           
 void setPageNumber(int pageNumber)
           
 void setTaskId(java.lang.String taskId)
           
 void setToSequence(int toSeq)
           
 
Methods inherited from class com.waveset.object.PersistentObject
addCommonElements, addEndTag, addMemberObjectGroup, addMemberObjectGroup, addPersistentAttributes, addStartTag, addSummaryAttributes, addXmlHeader, attributesMatch, attributesMatch, attributesMatch, checkReference, checkReferences, clearId, cloneAs, cloneObject, compareTo, create, create, create, create, createLastModItem, createLastModItem, createLastModItemList, directObjectGroupMember, dump, dumpFile, equals, fakeId, getAttribute, getAttributeValues, getAuthReferences, getAuthType, getBasicAttributes, getBasicAttributes, getBasicAttributes, getCache, getCounterValue, getCreateDate, getCreator, getDisplayableName, getDisplayName, getElementName, getEncryptedValues, getId, getIdOrName, getInitialInstances, getLastMod, getLastModDate, getLastModifier, getLastModItemId, getLockInfo, getMemberObjectGroupRefs, getMemberObjectGroupRefsUpTo, getMemberObjectGroups, getName, getNameOrId, getProperties, getProperty, getPropertyAsString, getPropertyList, getQueryableAttributes, getReference, getReferences, getRuleDrivenMemberObjectGroupRefs, getRuleDrivenMemberObjectGroupRefsUpTo, getRuleDrivenMemberObjectGroups, getSubtype, getSummaryAttributes, getSummaryString, hasEncryptedData, hashCode, identityEquals, isAlias, isHidden, isId, isProtected, isProtectedFromDelete, isReferencedIn, listOperationalAttributes, listQueryableReferenceAttributes, objectGroupMember, objectGroupMemberRef, parseCommonElement, parseCommonElements, parsePersistentAttributes, parseXml, parseXml, prepareForSerialization, prepareToSerialize, println, reEncrypt, reEncryptSubclassAttributes, removeMemberObjectGroup, removeProperty, resolve, resolve, resolve, resolveArray, resolveArrayByFetching, resolveObjectReference, resolveObjectReferences, resolveReference, resolveSummaryAttributes, resolveSummaryAttributes, ruleDrivenObjectGroupMemberRef, setAuthType, setAuthType, setCache, setCreateDate, setCreator, setDisplayName, setDisplayName, setHidden, setIsAlias, setLastMod, setLastMod, setLastModDate, setLastModifier, setMemberObjectGroupRef, setMemberObjectGroupRefs, setMemberObjectGroups, setName, setProperties, setProperty, setPropertyList, setProtected, setProtectedFromDelete, setRuleDrivenMembersCache, setSubtype, setTrace, toString, toXml, toXml, toXml, toXmlFile, visit
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values

EL_HTML

public static final java.lang.String EL_HTML
See Also:
Constant Field Values
Constructor Detail

TaskResultPage

public TaskResultPage()
Create an empty task result, ready to be filled.


TaskResultPage

public TaskResultPage(java.lang.String taskId,
                      int pageNumber,
                      int fromSeq,
                      int toSeq,
                      java.lang.String html)
               throws InvalidArgument
Build a page with HTML representing a range of task extended results.


TaskResultPage

public TaskResultPage(org.w3c.dom.Element e)
               throws WavesetException
Deserialize a task result page.

Method Detail

getTaskId

public java.lang.String getTaskId()

setTaskId

public void setTaskId(java.lang.String taskId)
               throws InvalidArgument
Throws:
InvalidArgument

getPageNumber

public int getPageNumber()

setPageNumber

public void setPageNumber(int pageNumber)
                   throws InvalidArgument
Throws:
InvalidArgument

getFromSequence

public int getFromSequence()

setFromSequence

public void setFromSequence(int fromSeq)

getToSequence

public int getToSequence()

setToSequence

public void setToSequence(int toSeq)

getHTML

public java.lang.String getHTML()

setHTML

public void setHTML(java.lang.String html)

getType

public Type getType()
Returns the associated Type object.

Specified by:
getType in class PersistentObject

getName

public static java.lang.String getName(TaskInstance task,
                                       int pageNumber)
                                throws InvalidArgument
Returns:
a generated task result page name.
Throws:
InvalidArgument

getName

public static java.lang.String getName(java.lang.String taskId,
                                       int pageNumber)
                                throws InvalidArgument
Returns:
a generated task result name.
Throws:
InvalidArgument

getNameBase

public static java.lang.String getNameBase(java.lang.String taskId)
                                    throws InvalidArgument
Returns:
a generated task result name.
Throws:
InvalidArgument

forTask

public static AttributeCondition[] forTask(TaskInstance ti)
                                    throws InvalidArgument
Throws:
InvalidArgument

forTask

public static AttributeCondition[] forTask(java.lang.String parentTaskId)
                                    throws InvalidArgument
Throws:
InvalidArgument

listQueryableAttributes

public java.util.List listQueryableAttributes()
Overrides:
listQueryableAttributes in class PersistentObject
Returns:
the complete list of 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.listQueryableAttributes() to ensure that the subclass includes queryable attributes that are common to all PersistentObjects.


listSummaryAttributes

public java.util.List listSummaryAttributes()
Description copied from class: PersistentObject
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).

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.

Overrides:
listSummaryAttributes in class PersistentObject
Returns:
the complete list of 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.

See Also:
Constants.MAX_SUMMARY_STRING_LENGTH, PersistentObject.getSummaryString()

getAttributeValues

protected WSAttribute getAttributeValues(java.lang.String attrName)
Overrides:
getAttributeValues in class PersistentObject
Parameters:
attrName - - the name of the attribute for which to return values.
Returns:
a WSAttribute that represents the value (or values) that this object contains for the specified attribute.


addSubclassAttributes

protected void addSubclassAttributes(java.lang.StringBuffer buf)
Description copied from class: PersistentObject
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). PersistentObject's default implementation is a no-op.

NOTE: Any subclass that overrides this method must similarly override parseSubclassAttributes() so that the subclass attributes are restored.

Overrides:
addSubclassAttributes in class PersistentObject
See Also:


addSubclassElements

protected void addSubclassElements(java.lang.StringBuffer buf)
Description copied from class: PersistentObject
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). PersistentObject's default implementation is a no-op.

NOTE: Any subclass that overrides this method must similarly override parseSubclassElements() so that the subclass elements are restored.

Overrides:
addSubclassElements in class PersistentObject
See Also:


parseSubclassAttributes

protected void parseSubclassAttributes(org.w3c.dom.Element e)
                                throws WavesetException
Description copied from class: PersistentObject
Each concrete subclass should parse from the XML buffer any persisted subclass-specific fields (generally, the same ones that it writes into the buffer).

Overrides:
parseSubclassAttributes in class PersistentObject
Throws:
WavesetException
See Also:

PersistentObject's default implementation is a no-op.

, PersistentObject.parseXml(Element)

parseSubclassElements

protected void parseSubclassElements(org.w3c.dom.Element e)
                              throws WavesetException
Description copied from class: PersistentObject
Each concrete subclass should parse from the XML buffer any persisted subclass-specific elements (generally, the same ones that it writes into the buffer).

Overrides:
parseSubclassElements in class PersistentObject
Throws:
WavesetException
See Also:

PersistentObject's default implementation is a no-op.

, PersistentObject.parseXml(Element)

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception
Throws:
java.lang.Exception