|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWFieldsObject | +--filenet.vw.api.VWWorkElement | +--filenet.vw.api.VWRosterElement
Use this class to access a roster element and fetch a work object or an instruction element.
A roster element represents an individual work object in a roster. An instance of this class accesses system-defined, indexed, and exposed fields without the expense of retrieving an entire work object.
Call the VWRoster.createQuery() method specify a fetch type of roster element. Subsequent calls of VWRosterQuery.next() create instances of the VWRosterElement class.
VWRosterQuery
,
VWWorkObject
,
VWInstructionElement
, Serialized FormMethod Summary | |
VWInstructionElement |
fetchInstructionElement(boolean lock,
boolean overrideLock)
Fetches the instruction element that corresponds to the roster element. |
VWWorkObject |
fetchWorkObject(boolean lock,
boolean overrideLock)
Fetches the work object that corresponds to this roster element. |
VWDataField[] |
getDataFields()
Lists exposed data fields this roster element supports. |
java.lang.String[] |
getFieldNames()
Lists the system-defined field names and user-defined exposed field names supported by the roster element. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Gets the value of a field in the roster element. |
java.util.Date |
getLaunchDate()
Gets the launch date of the workflow process that contains the work object. |
java.lang.String |
getOriginator()
Gets the name of the user who initiated the workflow process that contains this work object. |
VWProcess |
getProcess()
Deprecated. Replaced by VWStepElement.fetchProcess() or
VWWorkObject.fetchProcess() , depending on the type of process |
java.lang.String |
getRosterName()
Returns the name of the roster. |
int |
getServerLocation()
Gets the current server location of the work object. |
java.lang.String |
getStepName()
Gets the step name. |
java.lang.String |
getTag()
Gets the tag of the work object (as a string). |
java.lang.String |
getWorkflowNumber()
Gets the string version of the WorkFlow number. |
java.lang.String |
getWorkFlowNumber()
Deprecated. Replaced by getWorkflowNumber() |
java.lang.String |
getWorkObjectName()
Gets the work object name. |
java.lang.String |
getWorkObjectNumber()
Gets the work object number (as a string). |
boolean |
hasFieldName(java.lang.String fieldName)
Determines whether the specified field exists. |
boolean |
isSystemField(java.lang.String fieldName)
Determines whether the field is a system field. |
java.lang.String |
toString()
Gets a string version of a work object name. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWRosterElement object to the buffer specified by the input parameter. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public VWInstructionElement fetchInstructionElement(boolean lock, boolean overrideLock) throws VWException
lock
- A Boolean value. Specify true to lock the work object.
Specify false to leave the lock active.overrideLock
- A Boolean value. Specify true to override
an existing lock on the work object.VWException
- Thrown if it cannot
fetch the instruction element that corresponds to the roster
element.public VWWorkObject fetchWorkObject(boolean lock, boolean overrideLock) throws VWException
lock
- A Boolean value. Specify true to lock the work
object. Specify false to leave the lock active.overrideLock
- A Boolean value. Specify true to override
an existing lock on the work object.VWException
- Thrown if it cannot
fetch the work object that corresponds to this roster element.public java.lang.String[] getFieldNames()
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- The name of the field
containing the value being retrieved.VWException
- The method throws an exception if the
field name specified in the fieldName parameter does not exist.public boolean isSystemField(java.lang.String fieldName) throws VWException
fieldName
- The name to be checked.VWException
- Thrown if it cannot
determine whether the field is a system field.public boolean hasFieldName(java.lang.String fieldName) throws VWException
fieldName
- The name of the field
being checked.VWException
- The method throws an exception if the
field name specified in the fieldName parameter is null.public java.lang.String getWorkObjectName() throws VWException
VWException
- Thrown if it cannot
get the work object name.public java.lang.String getWorkObjectNumber() throws VWException
VWException
- Thrown if it cannot
get the work object number.public java.lang.String getTag() throws VWException
VWException
- Thrown if it cannot
get the tag of the work object.public int getServerLocation() throws VWException
getServerLocation
in class filenet.vw.api.VWFieldsObject
VWException
- Thrown if it cannot
get the current server location of the work object.public java.lang.String toString()
toString
in class java.lang.Object
public VWProcess getProcess() throws VWException
VWStepElement.fetchProcess()
or
VWWorkObject.fetchProcess()
, depending on the type of process
VWException
- Thrown if it cannot
get the workflow process associated with the roster element.public VWDataField[] getDataFields() throws VWException
VWException
- Thrown if it cannot
list exposed data fields supported by the roster element.VWDataField
public java.lang.String getRosterName() throws VWException
VWException
- Thrown if it cannot
return the name of the roster.public java.util.Date getLaunchDate() throws VWException
VWException
- Thrown if it cannot
get the launch date of the workflow process that contains the
work object.public java.lang.String getOriginator() throws VWException
VWException
- Thrown if it cannot
get the name of the user who launched the workflow process
that contains the work object.public java.lang.String getWorkFlowNumber() throws VWException
getWorkflowNumber()
getWorkFlowNumber
in class filenet.vw.api.VWFieldsObject
VWException
- Thrown if it cannot
get the string version of the WorkFlow number.public java.lang.String getWorkflowNumber() throws VWException
VWException
- Thrown if it cannot
get the string version of the WorkFlow number.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
toXML
in interface IVWtoXML
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
public java.lang.String getStepName() throws VWException
VWException
- Thrown if the method is unable to get a string
containing the step name.
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |