|
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.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
,
VWInstructionElement
, 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 |
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)
Fetches the corresponding instruction element for the workflow object associated with the queue element. |
VWStepElement |
fetchStepElement(boolean lock,
boolean overrideLock)
Fetches the current step in the workflow process. |
VWStepProcessorInfo |
fetchStepProcessorInfo()
Fetches the step processor object containing the information needed to launch a workflow. |
VWWorkObject |
fetchWorkObject(boolean lock,
boolean overrideLock)
Fetches the workflow object associated with this queue element. |
VWDataField[] |
getDataFields()
Gets a list of data fields supported by this queue element. |
java.lang.String[] |
getFieldNames()
Lists the names of both user-defined or system field names that the queue element supports and user-defined fields you selected (with Composer) 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 of the 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()
Gets the name of the user who has locked the workflow object. |
java.lang.String |
getMapName()
Gets the name of the map for the workflow object. |
java.lang.String |
getOperationName()
Gets the current Operation name of the workflow object. |
java.lang.String |
getQueueName()
Gets the name of the queue in which the workflow object currently resides. |
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 the queue element. |
java.lang.String[] |
getSystemDefinedFieldNames()
Lists names of the Process Engine 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 the queue element. |
java.lang.String |
getWorkClassName()
Gets the name of the work class from which the 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 string version of the WorkFlow number. |
java.lang.String |
getWorkObjectName()
Gets the workflow object name. |
java.lang.String |
getWorkObjectNumber()
Gets the workflow object. |
java.lang.String |
getWorkPerformerClassName()
Deprecated. Replaced by getQueueName() |
boolean |
hasFieldName(java.lang.String fieldName)
Determines whether the specified field exists. |
boolean |
isSystemField(java.lang.String fieldName)
Determines whether the field data type is a system field. |
java.lang.String |
toString()
Gets the workflow object name. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWQueueElement object to the buffer specified by the input parameter. |
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 VWInstructionElement fetchInstructionElement(boolean lock, boolean overrideLock) throws VWException
lock
- A boolean value; specify true
to lock
the workflow object.overrideLock
- A boolean value; specify true
to
override locks on the workflow object.VWException
- The method throws an exception if it cannot
fetch the corresponding instruction element for the workflow
object associated with the queue element.public VWWorkObject fetchWorkObject(boolean lock, boolean overrideLock) throws VWException
lock
- A boolean value. Specify true
to lock the workflow
object.overrideLock
- A boolean value. Specify true
to override
locks on the workflow object.VWException
- The method throws an exception if it cannot
fetch the workflow object associated with the queue element.public static java.lang.String ConvertTagToName(java.lang.String aTag, int aTagType) throws java.lang.Exception
aTag
- The workflow object name (the
value in the F_Tag system field).aTagType
- An integer value associated with the data tag
type.VWException
- The method throws an exception if it cannot
convert the tag and the type of data in the tag to the string
version of a workflow object name.public static java.lang.String ConvertNameToTag(java.lang.String aWorkObjectName, int aTagType) throws java.lang.Exception
aWorkObjectName
- The workflow object
name.aTagType
- An integer value associated with the data tag
type (in the tag property of the workflow object name).VWException
- The method throws an exception if it cannot
convert the string version of a workflow object name or tag
type to a tag.public java.lang.String[] getFieldNames()
The following system fields are associated with each queue element:
Field name | Field description | Value | Value description |
F_WobNum | Workflow object number | ||
F_WorkSpaceId | Workspace ID | ||
F_Locked | Workflow object lock status | 0 1 2 |
Unlocked Locked by user Locked by system |
F_LockedMachine | Source of lock | 0 -1 -2 |
None (unlocked) Process Engine |
F_LockedTime | Time of the workflow object lock (The year 1906 indicates that the workflow object is not locked.) | ||
F_BindPending | Pending bind type (A pending bind to a user or machine occurs upon the next workflow object lock.) | 0 1 2 3 |
None Machine User Machine and user |
F_BoundUser | User to whom the workflow object is bound. Zero indicates that the workflow object is not bound to a user. | ||
F_BoundMachine | Machine to which the workflow object is bound. Zero indicates that the workflow object is not bound to a machine. | ||
F_Tag | Normalized workflow object ID field | ||
F_UniqueId | ID that changes upon workflow object update | ||
F_OperationId | Work Performer Operation ID | ||
F_WorkClassId | Work class ID | ||
F_EnqueueTime | Time of workflow object insertion in the queue | ||
F_CreateTime | Workflow object creation time | ||
F_InstrSheetId | ID of the current instruction sheet. "-1" indicates there is no current instruction sheet. | ||
F_WorkOrderId | ID of the current work order | ||
F_SortOrder | Sort string created by sort rules defined in Composer |
public java.lang.String[] getSystemDefinedFieldNames()
public java.lang.String[] getUserDefinedFieldNames()
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- The name of the field.VWException
- The method throws an exception if the field
specified in the fieldName parameter 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 the user selects them to be queue fields in Composer.
true
if the field
is a system field; otherwise, the method returns false
.VWException
- The method throws an exception if it cannot
determine whether the field data type is a system field.public boolean hasFieldName(java.lang.String fieldName) throws VWException
fieldName
- The name of the field be checked.true
if the field
specified in the fieldName parameter exists; otherwise, the
method returns false
.VWException
- The method throws an exception if the
value in the fieldName parameter is null.public java.lang.String getWorkObjectName() throws VWException
VWException
- The method throws an exception if it cannot
get the workflow object name.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
- The method throws an exception if it cannot
get the name of the source work class.public java.lang.String getWorkflowName() throws VWException
VWException
- The method throws an exception if it cannot
get the name of the work class from which the workflow object
logged was instantiated.public java.lang.String getWorkPerformerClassName() throws VWException
getQueueName()
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
- The method throws an exception if it cannot
get the name of the queue in which the workflow object
currently resides.public java.lang.String getOperationName() throws VWException
VWException
- The method throws an exception if it cannot
get the current Operation name of the workflow object.public java.lang.String getStepName() throws VWException
getStepName
in class filenet.vw.api.VWFieldsObject
VWException
- The method throws an exception if it cannot
get the step label for the queue element.public java.lang.String getInstructionSheetName() throws VWException
VWException
- The method throws an exception if it cannot
get the name of the instruction sheet of the workflow object.
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 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. Specify true
to lock the workflow
object; otherwise, specify false
.overrideLock
- A boolean value. Specify true
to override existing
locks on the workflow object; otherwise, specify false
.VWException
- The method throws an exception if the
system fails to fetch the step element.public java.lang.String getMapName() throws VWException
VWException
- The method throws an exception if it cannot
get the name of the map for the workflow object.public VWDataField[] getDataFields() throws VWException
VWException
- The method throws an exception if it cannot
get a list of data fields supported by the queue element.VWDataField
public int getStepDeadlineStatus() throws VWException
VWException
- public VWStepProcessorInfo fetchStepProcessorInfo() 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 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 getWorkFlowNumber() throws VWException
VWException
- public int getServerLocation() throws VWException
VWException
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |