|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWQueueElement
public final class VWQueueElement
Accesses queue fields and Instruction Elements of a workflow object associated with a queue. Accessing these fields in a VWQueueElement is more efficient than retrieving the entire workflow object. Query procedures using the VWQueueQuery.next() method create instances of this class.
VWQueueQuery
,
VWWorkObject
,
VWStepElement
,
Serialized FormField Summary | |
---|---|
static int |
COMPLETED
Value of 3. This value indicates that a step element has completed. |
static int |
DEADLINE_NOT_REACHED
Value of 0. This value indicates that a step element is still waiting to reach a deadline. |
static int |
DEADLINE_REACHED
Value of 2. This value indicates that a step element has reached a deadline. |
static int |
DEADLINE_REMINDER_NOTICE
Value of 1. This value indicates whether or not a step element has reached the deadline reminder notice. |
static int |
DTBOOLEAN
Value of 2. This value indicates that the type of the data in a workflow object field data type is Boolean. |
static int |
DTINTEGER
Value of 1. This value indicates that the type of the data in a workflow object field data type is integer. |
static int |
DTSTRING
Value of 0. This value indicates that the type of the data in a workflow object field data type is string. |
static int |
LOCKED_BY_NONE
Value of 0. |
static int |
LOCKED_BY_SYSTEM
Value of 2. This value indicates whether a workflow object is locked by the system. |
static int |
LOCKED_BY_USER
Value of 1. This value indicates whether a workflow object is locked by a user. |
Method 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. |
static java.lang.String |
ConvertNameToTag(java.lang.String aWorkObjectName,
int aTagType)
Converts the string version of a workflow object name or tag type to a tag. |
static java.lang.String |
ConvertTagToName(java.lang.String aTag,
int aTagType)
Converts the tag and the type of data in the tag to the string version of a workflow object name. |
VWInstructionElement |
fetchInstructionElement(boolean lock,
boolean overrideLock)
Deprecated. Use fetchStepElement instead.
Fetches the corresponding instruction element for the workflow
object associated with the queue element. If a translation source
exists, the authored instruction element information is translated. |
VWStepElement |
fetchStepElement(boolean lock,
boolean overrideLock)
Fetches the current step in the workflow process. |
VWStepProcessorInfo |
fetchStepProcessorInfo()
Fetches the step processor information associated with this instance. |
VWWorkObject |
fetchWorkObject(boolean lock,
boolean overrideLock)
Fetches the workflow object associated with this queue element. |
java.lang.String[] |
getAuthoredFieldNames()
Lists the authored (untranslated) names of both user-defined and system field names that this queue element supports, as well as user-defined fields selected to be queue fields. |
java.lang.String |
getAuthoredStepName()
Gets the authored step name for this queue 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 that this queue element supports, as well as the user-defined fields selected to be queue fields. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Gets the value of a specific field. |
java.lang.String |
getInstructionSheetName()
Gets the name of the instruction sheet for this workflow object. |
int |
getLockedMachine()
Gets the machine type of the system that locked the workflow object. |
int |
getLockedStatus()
Determines the lock status for the workflow object. |
java.lang.String |
getLockedUser()
Returns the name of the user who has locked the workflow object. |
VWParticipant |
getLockedUserPx()
Returns the VWParticipant (security) object that represents the user who locked the current work object. |
java.lang.String |
getMapName()
Gets the name of the map for this workflow object. |
java.lang.String |
getOperationName()
Gets the current operation name for this workflow object. |
int |
getProcessorId()
Fetches the step processor object containing the information needed to launch a workflow. |
java.lang.String |
getQueueName()
Gets the name of the queue in which this work object currently resides. |
java.lang.String |
getSelectedResponse()
Return the value in the F_Response system field for this object. |
int |
getServerLocation()
Gets the current server location of the work object. |
int |
getStepDeadlineStatus()
Gets the deadline status for the current step. |
java.lang.String |
getStepName()
Gets the step label for this queue element. |
java.lang.String |
getSubject()
Returns the value in the F_Subject system field for this object. |
java.lang.String[] |
getSystemDefinedFieldNames()
Lists the names of the system fields supported by this queue element. |
java.lang.String |
getTag()
Gets the tag of the workflow object. |
java.lang.String[] |
getUserDefinedFieldNames()
Lists the names of the user-defined fields supported by this queue element. |
java.lang.String |
getWorkClassName()
Gets the name of the work class from which this workflow object is instantiated. |
java.lang.String |
getWorkflowName()
Gets the name of the work class from which the workflow object logged was instantiated. |
java.lang.String |
getWorkFlowNumber()
Gets the workflow number. |
java.lang.String |
getWorkObjectName()
Gets the name of this work object. |
java.lang.String |
getWorkObjectNumber()
Gets the workflow object. |
java.lang.String |
getWorkPerformerClassName()
Deprecated. Replaced by getQueueName()
Gets the name of the Work Performer Class associated with the
queue on which the workflow object currently resides. |
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 the workflow 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 |
Field Detail |
---|
public static final int LOCKED_BY_NONE
To determine the lock status of a workflow object, see the getLockedStatus method in this class and the fetchLockStatus method in the VWInstructionElement class.
public static final int LOCKED_BY_USER
To determine the lock status of a workflow object, use the VWQueueElement.getLockedStatus() method and the VWInstructionElement.fetchLockedStatus method.
public static final int LOCKED_BY_SYSTEM
To determine the lock status of a workflow object, use the VWQueueElement.getLockedStatus() method and the VWInstructionElement.fetchLockStatus() method.
public static final int DEADLINE_NOT_REACHED
public static final int DEADLINE_REMINDER_NOTICE
public static final int DEADLINE_REACHED
public static final int COMPLETED
public static final int DTSTRING
Use these values as inputs for the aTagType parameter in the ConvertTagToName() and ConvertNameToTag() methods of this class.
public static final int DTINTEGER
Use these values as inputs for the aTagType parameter in the ConvertTagToName() and ConvertNameToTag() methods of this class.
public static final int DTBOOLEAN
Use these values as inputs for the aTagType parameter in the ConvertTagToName() and ConvertNameToTag() methods of this class.
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
instead.
Fetches the corresponding instruction element for the workflow
object associated with the queue element. If a translation source
exists, the authored instruction element information is translated.
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 corresponding instruction element for the workflow
object associated with the queue element cannot be returned.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 queue element cannot be retrieved.public static java.lang.String ConvertTagToName(java.lang.String aTag, int aTagType) throws java.lang.Exception
Valid data tag values are as follows:
aTag
- The tag to convert. The tag is the value in the F_Tag system field.aTagType
- An integer associated with the data tag type.
java.lang.Exception
- Thrown if the tag and tag type cannot be converted to a string
version of a workflow object name.public static java.lang.String ConvertNameToTag(java.lang.String aWorkObjectName, int aTagType) throws java.lang.Exception
Valid data tag values are as follows:
aWorkObjectName
- A String containing the workflow object name. If a translation source exists, the
workflow object name is translated.aTagType
- An integer associated with the data tag
type (in the Tag property of the workflow object specified).
java.lang.Exception
- Thrown if the string version of the workflow object name or tag
type specified cannot be converted to a tag.public java.lang.String[] getFieldNames()
public java.lang.String[] getAuthoredFieldNames()
public java.lang.String[] getSystemDefinedFieldNames()
public java.lang.String[] getUserDefinedFieldNames()
User-defined fields can be system fields if they are configured as queue fields.
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_". User-defined fields are system fields if they are selected to be queue fields.
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 getWorkObjectName() throws VWException
VWException
- Thrown if the work object name cannot be found.public java.lang.String getWorkObjectNumber() throws VWException
VWException
- The method throws an exception if it cannot
get the index value of the workflow object.public java.lang.String getTag() throws VWException
VWException
- The method throws an exception if it cannot
get a standardized tag of the workflow object.public java.lang.String getWorkClassName() throws VWException
VWException
- Thrown if the name of the source work class cannot be found.public java.lang.String getWorkflowName() throws VWException
VWException
- Thrown if the name of the work class from which the workflow object
logged was instantiated.public java.lang.String getWorkPerformerClassName() throws VWException
getQueueName()
Gets the name of the Work Performer Class associated with the
queue on which the workflow object currently resides.
VWException
- The method throws an exception if it cannot
get the name of the Work Performer Class associated with the
queue on which the workflow object currently resides.public java.lang.String getQueueName() throws VWException
VWException
- Thrown if the queue name cannot be found.public java.lang.String getOperationName() throws VWException
VWException
- Thrown if the current operation name for this workflow object cannot
be found.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 getInstructionSheetName() throws VWException
VWException
- Thrown if the name of the instruction sheet for this workflow object cannot be
found.public java.lang.String getLockedUser() throws VWException
VWException
- The method throws an exception if it cannot
get the name of the user who has locked the workflow object.public VWParticipant getLockedUserPx() throws VWException
VWException
public int getLockedStatus() throws VWException
VWException
- The method throws an exception if it cannot
determine the lock status for the workflow object.public int getLockedMachine() throws VWException
VWException
- The method throws an exception if it cannot
get the machine type of the system that locked the workflow
object.public java.lang.String toString()
toString
in class java.lang.Object
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 getMapName() throws VWException
VWException
- Thrown if the name of the map for this workflow object cannot be found.public VWDataField[] getDataFields() throws VWException
VWException
- Thrown list of data fields supported cannot be retrieved.VWDataField
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 name is translated.
VWException
public java.lang.String getSelectedResponse() throws VWException
VWException
public java.lang.String getSubject() throws VWException
VWException
- Thrown if a problem occurs retrieving
the field from this object.public int getStepDeadlineStatus() throws VWException
VWException
public int getProcessorId() throws VWException
VWException
- The method throws an exception if it cannot
fetch the step processor object containing the information
needed to launch a workflow.public VWStepProcessorInfo fetchStepProcessorInfo() throws VWException
VWException
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
public java.lang.String getWorkFlowNumber() throws VWException
VWException
- An exception is thrown under the following conditions:
public int getServerLocation() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |