|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWRosterElement
public final class 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(String, Object[],
Object[], int, String, Object[], int)
method
to create a VWRosterQuery instance containing roster elements
of a given fetch type.
Subsequent calls of VWRosterQuery.next()
create instances of the VWRosterElement class.
VWRosterQuery
,
VWWorkObject
,
VWInstructionElement
,
Serialized FormMethod Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
VWInstructionElement |
fetchInstructionElement(boolean lock,
boolean overrideLock)
Deprecated. Replaced by fetchStepElement |
VWStepElement |
fetchStepElement(boolean lock,
boolean overrideLock)
Fetches the current step in the workflow process. |
VWWorkObject |
fetchWorkObject(boolean lock,
boolean overrideLock)
Fetches the work object that corresponds to this roster element. |
java.lang.String[] |
getAuthoredFieldNames()
Lists the authored (untranslated) names of both user-defined and system field names that this roster element supports. |
java.lang.String |
getAuthoredStepName()
Gets the authored step name for this roster element. |
VWDataField |
getDataField(java.lang.String name)
Gets the requested data field from the log element. |
VWDataField[] |
getDataFields()
Gets the list of data fields supported by this queue element. |
java.lang.String[] |
getFieldNames()
Lists the names of both user-defined and system field names supported by this roster element. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Gets the value of a specified field in this roster element. |
java.util.Date |
getLaunchDate()
Gets the launch date of the workflow process that contains the work object. |
java.lang.String |
getOriginator()
Returns the name of the user who initiated the workflow process that contains this work object. |
VWParticipant |
getOriginatorPx()
Returns the VWParticipant (security) object that represents the user who initiated the workflow process containing the current step. |
VWProcess |
getProcess()
Deprecated. Replaced by VWStepElement.fetchProcess() or
VWWorkObject.fetchProcess() , depending on the type of process. |
java.lang.String |
getRosterName()
Gets the name of this roster. |
java.lang.String |
getSelectedResponse()
Returns the value in the F_Response system field for this object. |
int |
getServerLocation()
Gets the current server location of the work object. |
java.lang.String |
getStepName()
Gets the step label for this roster element. |
java.lang.String |
getSubject()
Returns the value in the F_Subject system field for this object. |
java.lang.String |
getTag()
Gets the tag of the work object (as a string). |
java.lang.String |
getWorkflowNumber()
Gets the workflow number. |
java.lang.String |
getWorkFlowNumber()
Deprecated. Replaced by getWorkflowNumber() |
java.lang.String |
getWorkObjectName()
Gets the name of this work object. |
java.lang.String |
getWorkObjectNumber()
Gets the work object number (as a string). |
boolean |
hasFieldName(java.lang.String fieldName)
Indicates whether the specified field exists. |
boolean |
isSystemField(java.lang.String fieldName)
Indicates whether the field specified 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 representing this instance to the buffer specified. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public VWInstructionElement fetchInstructionElement(boolean lock, boolean overrideLock) throws VWException
fetchStepElement
lock
- Specify true
to lock the work object;
false
to leave the lock active.overrideLock
- true
to override
an existing lock on the work object.
VWException
- Thrown if the method cannot
fetch the instruction element that corresponds to the roster
element.public VWWorkObject fetchWorkObject(boolean lock, boolean overrideLock) throws VWException
lock
- A boolean value of true to lock the workflow object; false otherwise.overrideLock
- A boolean value of true to override locks on the workflow object; false
otherwise.
VWException
- Thrown if the workflow object associated with this roster element cannot be retrieved.public VWStepElement fetchStepElement(boolean lock, boolean overrideLock) throws VWException
lock
- A boolean value of true to lock the workflow
object; otherwise, false.overrideLock
- A boolean value of true to override existing
locks on the workflow object; otherwise, false.
VWException
- Thrown if the step element cannot be retrieved.public java.lang.String[] getFieldNames()
public java.lang.String[] getAuthoredFieldNames()
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- A String containing the name of the field. If a translation source exists, the
authored field name is translated.
Objects and arrays of objects must be one of the following types: Integer, String, Double, or Boolean.
VWException
- Thrown if the field
specified cannot be found.public boolean isSystemField(java.lang.String fieldName) throws VWException
System fields start with the prefix "F_".
fieldName
- The name of the field to check. If a translation source exists, the
authored field name is translated.
VWException
- Thrown if it cannot be
determined whether the field is a system field.public boolean hasFieldName(java.lang.String fieldName) throws VWException
fieldName
- The name of the field to check. If a translation source exists, the
authored field name is translated.
VWException
- Thrown if the fieldName parameter is null.public java.lang.String getStepName() throws VWException
VWException
- Thrown if the step label for this queue element cannot be found.public java.lang.String getAuthoredStepName() throws VWException
VWException
- Thrown if a step name cannot be found for this queue element.public java.lang.String getWorkObjectName() throws VWException
VWException
- Thrown if the workflow object name cannot be found.public java.lang.String getWorkObjectNumber() throws VWException
VWException
- Thrown when a new roster element is referenced. It will not have a work
object number until it is dispatched (becomes a work object).public java.lang.String getTag() throws VWException
VWException
- Thrown if the method cannot
get the tag of the work object.public int getServerLocation() throws VWException
VWException
- Thrown if the method 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 the method cannot
get the workflow process associated with the roster element.public VWDataField[] getDataFields() throws VWException
VWException
- Thrown list of data fields supported cannot be retrieved.public VWDataField getDataField(java.lang.String name) throws VWException
name
- A String containing the name of the data field. If a
translation source exists, the authored field name is translated.
VWException
public java.lang.String getSelectedResponse() throws VWException
name
- A String containing the name of the data field.
VWException
public java.lang.String getSubject() throws VWException
VWException
- Thrown if a problem occurs retrieving
the field from this object.public java.lang.String getRosterName() throws VWException
VWException
- Thrown if the roster name cannot be found.public java.util.Date getLaunchDate() throws VWException
VWException
- Thrown if the method cannot
get the launch date of the workflow process that contains the
work object.public java.lang.String getOriginator() throws VWException
VWException
public VWParticipant getOriginatorPx() throws VWException
VWException
public java.lang.String getWorkFlowNumber() throws VWException
getWorkflowNumber()
VWException
- Thrown if the method cannot
get the string version of the workflow number.public java.lang.String getWorkflowNumber() throws VWException
VWException
- An exception is thrown under the following conditions:
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |