Process Class Relationships
A B C D F G H I J L M N O P Q R S T U V W Y

A

ACTION_TYPE_ASSIGN - Static variable in class filenet.vw.api.VWActionType
Value of 0. Assigns a value to a work item data field during processing.
ACTION_TYPE_BEGIN_CHECKPOINT - Static variable in class filenet.vw.api.VWActionType
Value of 27. Marks the point at which values are saved for later use by the RollbackCheckpoint system function.
ACTION_TYPE_BEGIN_TIMER - Static variable in class filenet.vw.api.VWActionType
Value of 1. Indicates the start of a period of time during which you want a specified series of steps to process a workflow.
ACTION_TYPE_CALL - Static variable in class filenet.vw.api.VWActionType
Value of 5. Executes another workflow map.
ACTION_TYPE_CREATE - Static variable in class filenet.vw.api.VWActionType
Value of 6. Creates a new, unrelated workflow; for example, to satisfy a WaitForEvent.
ACTION_TYPE_DB_EXECUTE - Static variable in class filenet.vw.api.VWActionType
Value of 37. Call to a stored procedure in an external database.
ACTION_TYPE_DELAY - Static variable in class filenet.vw.api.VWActionType
Value of 7. Suspends the processing of a workflow for a specified period of time.
ACTION_TYPE_END_ALL_TIMERS - Static variable in class filenet.vw.api.VWActionType
Value of 8. Terminates all timers.
ACTION_TYPE_END_CHECKPOINT - Static variable in class filenet.vw.api.VWActionType
Value of 28. Marks the point where values previously saved by the BeginCheckPoint function are discarded and processing is continued with the next instruction.
ACTION_TYPE_END_TIMER - Static variable in class filenet.vw.api.VWActionType
Value of 9. Works with BeginTimer to mark the end of the series of steps.
ACTION_TYPE_EXECUTE - Static variable in class filenet.vw.api.VWActionType
Value of 23. Executes the current workflow map.
ACTION_TYPE_LOG - Static variable in class filenet.vw.api.VWActionType
Value of 38. Generates user-defined logging event.
ACTION_TYPE_NOOP - Static variable in class filenet.vw.api.VWActionType
Value of 24. Performs no action; useful for development situations.
ACTION_TYPE_RESUME_TIMER - Static variable in class filenet.vw.api.VWActionType
Value of 13. Reactivates a suspended timer.
ACTION_TYPE_RETURN - Static variable in class filenet.vw.api.VWActionType
Value of 14. Exits from a called workflow map and returns to the calling step.
ACTION_TYPE_ROLLBACK_CHECKPOINT - Static variable in class filenet.vw.api.VWActionType
Value of 29. Marks the point where you want the saved values (saved when BeginCheckpoint executed) to replace the current values in the data fields designated for roll back.
ACTION_TYPE_SUSPEND_TIMER - Static variable in class filenet.vw.api.VWActionType
Value of 16. Allows for uninterrupted processing without actually ending the timer.
ACTION_TYPE_TERMINATE - Static variable in class filenet.vw.api.VWActionType
Value of 17. Ends processing of a workflow.
ACTION_TYPE_WAIT_FOR_EVENT - Static variable in class filenet.vw.api.VWActionType
Value of 19. Suspends the processing of a workflow pending the creation of another, specific workflow having a specific work object ID.
ALL_FIELD_TYPES - Static variable in class filenet.vw.api.VWFieldType
Integer value representing the result of the following field values combined logically using an OR function: FIELD_TYPE_INT, FIELD_TYPE_STRING, FIELD_TYPE_BOOLEAN, FIELD_TYPE_FLOAT, FIELD_TYPE_TIME, FIELD_TYPE_ATTACHMENT, and FIELD_TYPE_PARTICIPANT.
APP_TYPE_JAVA - Static variable in class filenet.vw.api.VWStepProcessorInfo
Value of 64. This value indicates that the application type is JAVA code.
APP_TYPE_JAVA - Static variable in class filenet.vw.api.VWStepProcessorInfoDefinition
Value of 64. The application type is JAVA code Return value for getAppType method.
APP_TYPE_URL - Static variable in class filenet.vw.api.VWStepProcessorInfo
Value of 32. This value indicates that the application type is a URL.
APP_TYPE_URL - Static variable in class filenet.vw.api.VWStepProcessorInfoDefinition
Value of 32. The application type is a URL Return value for getAppType method.
AsXMLString() - Method in class filenet.vw.api.VWWorkflowDefinition
Retrieves an XML formatted representation of this workflow definition.
ATTACHMENT_TYPE_CUSTOM_OBJECT - Static variable in class filenet.vw.api.VWAttachmentType
Value of 6: indicating the attachment type is a Custom object.
ATTACHMENT_TYPE_DOCUMENT - Static variable in class filenet.vw.api.VWAttachmentType
Value of 3: indicating the attachment is the document type.
ATTACHMENT_TYPE_FOLDER - Static variable in class filenet.vw.api.VWAttachmentType
Value of 2: indicating the attachment is the folder type.
ATTACHMENT_TYPE_LIBRARY - Static variable in class filenet.vw.api.VWAttachmentType
Value of 1: indicating the attachment type is library or Object Store.
ATTACHMENT_TYPE_STORED_SEARCH - Static variable in class filenet.vw.api.VWAttachmentType
Value of 4: indicating the attachment is the stored search type.
ATTACHMENT_TYPE_UNDEFINED - Static variable in class filenet.vw.api.VWAttachmentType
Value of 0: indicating the attachment type is not known.
ATTACHMENT_TYPE_URL - Static variable in class filenet.vw.api.VWAttachmentType
Value of 5: indicating the attachment type is a UNC or URL.
ATTRIBUTES_REGION - Static variable in class filenet.vw.api.VWSession
Value of 2. Indicates region-specific attributes, for use with the VWSession.fetchAttributes(int) method.
ATTRIBUTES_SYSTEM - Static variable in class filenet.vw.api.VWSession
Value of 1. Indicates system-wide attributes, for use with the VWSession.fetchAttributes(int) method.

B

BASIC_FIELD_TYPES - Static variable in class filenet.vw.api.VWFieldType
Integer value representing the result of the following basic field values combined logically using an OR function: FIELD_TYPE_INT, FIELD_TYPE_STRING, FIELD_TYPE_BOOLEAN, FIELD_TYPE_FLOAT, and FIELD_TYPE_TIME.

C

changeStepType(int) - Method in class filenet.vw.api.VWMapDefinition
Replaces a VWStepDefinition with a VWCompoundStepDefinition or replaces a VWCompoundStepDefinition with a VWStepDefinition.
checkSystemWideFlagSetting(int) - Method in class filenet.vw.api.VWSession
Checks the system wide flag settings given the VWSystemAdministration System wide flag option.
checkWorkflowIdentifier(String) - Method in class filenet.vw.api.VWSession
Determines whether or not a workflow is on the Process Engine, given an associated workflow version ID.
clone() - Method in class filenet.vw.api.VWQueueDefinition
Creates a clone of this VWQueueDefinition object.
clone() - Method in class filenet.vw.api.VWLogDefinition
Creates a clone of this VWLogDefinition object.
clone() - Method in class filenet.vw.api.VWRosterDefinition
Creates a clone of this VWRosterDefinition object.
commit() - Method in class filenet.vw.api.VWSystemAdministration
Saves system administration changes to the system wide configuration on the workflow server, which take effect only after restarting the workflow services.
commit() - Method in class filenet.vw.api.VWSystemConfiguration
Saves system configuration changes to the current isolated region.
COMPLETED - Static variable in class filenet.vw.api.VWQueueElement
Value of 3.  This value indicates that a step element has completed.
convertClassNameToId(String, boolean) - Method in class filenet.vw.api.VWSession
Converts a roster or queue name to a class ID.
convertIdToClassName(int, boolean) - Method in class filenet.vw.api.VWSession
Converts a class ID to a roster name or queue name.
convertIdToUserName(int) - Method in class filenet.vw.api.VWSession
Converts a user ID to a user name.
convertInstructionSheetNameToId(String) - Method in class filenet.vw.api.VWWorkflowSignature
Converts an instruction sheet name to an instruction sheet ID.
ConvertNameToTag(String, int) - Static method in class filenet.vw.api.VWQueueElement
Converts the string version of a workflow object name or tag type to a tag.
convertOperationIdToName(int) - Method in class filenet.vw.api.VWQueue
Converts an Operation ID to a name, using the name/ID pair in the current workspace.
convertOperationNameToId(String) - Method in class filenet.vw.api.VWQueue
Converts an Operation name to an ID, using the name/ID pair in the current workspace.
ConvertTagToName(String, int) - Static method in class filenet.vw.api.VWQueueElement
Converts the tag and the type of data in the tag to the string version of a workflow object name.
convertUserNameToId(String) - Method in class filenet.vw.api.VWSession
Converts a user name in three-part format (name:domain:organization)to user ID.
createAssignInstruction(String[][]) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates an Assign instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createBeginCheckPointInstruction() - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a begin checkpoint instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createBeginTimerInstruction(String, String, String, String) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a begin timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createCallInstruction(String) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a call instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createCompoundStep(String) - Method in class filenet.vw.api.VWMapDefinition
Creates a compound step on the Workflow Map.
createCreateInstruction(String, String[][]) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a Create instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createDatabaseExecuteInstruction(String, String, String[]) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a Database Execute instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createDelayInstruction(String) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a delay instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createEndAllTimersInstruction() - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates an end all timers instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createEndCheckPointInstruction() - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates an end checkpoint instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createEndTimerInstruction(String) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates an End Timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createEvent(String, String, String) - Method in class filenet.vw.api.VWWFEInstruction
Creates an event in this VWWFEInstruction instance.
createExecuteInstruction(String, String, String[]) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates an Execute instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createFieldDefinition(String, int, int) - Method in class filenet.vw.api.VWQueueDefinition
Creates an exposed field in the queue, using the passed field name and type.
createFieldDefinition(String, int, int) - Method in class filenet.vw.api.VWLogDefinition
Creates an exposed field on this log from the supplied field name and type.
createFieldDefinition(String, int, int) - Method in interface filenet.vw.api.IVWTableDefinition
Creates an exposed field by passing in a field name and the type.
createFieldDefinition(String, int, int) - Method in class filenet.vw.api.VWRosterDefinition
Creates an exposed field on the roster, based on the supplied field name and type.
createFieldUsingObject(String, Object) - Method in class filenet.vw.api.VWWorkflowDefinition
Creates a data field in this workflow definition, with values initialized by an object.
createFieldUsingString(String, String, int, boolean) - Method in class filenet.vw.api.VWWorkflowDefinition
Creates a data field in this workflow definition, with values initialized by a field.
createIndexDefinition(String, String[]) - Method in class filenet.vw.api.VWQueueDefinition
Creates an index definition for the queue.
createIndexDefinition(String, String[]) - Method in class filenet.vw.api.VWLogDefinition
Creates an index definition for the specified log.
createIndexDefinition(String, String[]) - Method in interface filenet.vw.api.IVWTableDefinition
Creates an index definition for this queue.
createIndexDefinition(String, String[]) - Method in class filenet.vw.api.VWRosterDefinition
Creates an index definition for the roster.
createLiveWorkObject(String[], Object[], String, int) - Method in class filenet.vw.api.VWSession
Creates (initializes, saves, and dispatches) work items from a transferred workflow definition, specified by its workflow identifier. Supports multiple work classes on one roster.
createLogDefinition(String) - Method in class filenet.vw.api.VWSystemConfiguration
Creates a log definition.
createLogInstruction(String, String) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a log instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createMap(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Creates a new map in this workflow definition.
createMilestone(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Creates a new milestone in this workflow definition.
createNewWorkObject(String) - Method in class filenet.vw.api.VWSession
Deprecated. Replaced by VWSession.createLiveWorkObject(String[], Object[], String, int)
createNoOpInstruction() - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a NoOp instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createOperation(String) - Method in class filenet.vw.api.VWQueueDefinition
Creates an operation definition in this queue.
createParameter(String, int, int, boolean) - Method in class filenet.vw.api.VWOperationDefinition
Creates a parameter definition object.
createParameter(String, int, String, int, boolean) - Method in class filenet.vw.api.VWStepDefinition
Creates a parameter with name, direction, value, and type information.
createParameter(VWParameterDefinition) - Method in class filenet.vw.api.VWOperationDefinition
Creates a parameter definition object from another parameter definition object. The name of the parameter cannot match the name of any other parameter in this operation (VWOperationDefinition object).
createQuery(String, Object[], Object[], int, String, Object[], int) - Method in class filenet.vw.api.VWRoster
Performs a filtered fetch of roster items. The filters specify search conditions flexibly and include setting a range for the search index.
createQuery(String, Object[], Object[], int, String, Object[], int) - Method in class filenet.vw.api.VWQueue
Performs a filtered fetch of queue items. The filters specify search conditions flexibly and include setting a range for the search index.
createQueueDefinition(String, int) - Method in class filenet.vw.api.VWSystemConfiguration
Creates a queue definition.
createResumeTimerInstruction(String) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a Resume Timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createReturnInstruction(String) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a Return instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createRollbackCheckpointInstruction(String, String, String[]) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a Rollback Checkpoint instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createRosterDefinition(String) - Method in class filenet.vw.api.VWSystemConfiguration
Creates a roster definition.
createRoute(int) - Method in class filenet.vw.api.VWMapNode
Creates an outbound route for the current step. This step will be the implicit source step for the route.
createRuleSet(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Creates a new VWRuleSetDefinition objects in this workflow.
createStep(String) - Method in class filenet.vw.api.VWMapDefinition
Creates a step on the Workflow Map.
createStepProcessorInfoDefinition() - Method in class filenet.vw.api.VWSystemConfiguration
Creates a step processor definition.
createSuspendTimerInstruction(String) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a Suspend Timer instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createTerminateInstruction() - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a Terminate instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createUserInfo() - Method in class filenet.vw.api.VWSystemAdministration
Creates an empty VWUserInfo object.
createWFEInstruction(String, String) - Method in class filenet.vw.api.VWCompoundStepDefinition
Creates a Wait For Event instruction in this compound step definition, assigning it a new instruction Id, and appending it to the instruction list for this compound step.
createWorkflow(String) - Method in class filenet.vw.api.VWSession
Launches a workflow defined by a transferred workflow definition, as specified by a workflow identifier version String derived from a VWTransferResult object or a workflow definition name (work class name).
createWorkObject() - Method in class filenet.vw.api.VWRoster
Deprecated. Replaced by VWSession.createNewWorkObject(String)

D

DATABASE_ORACLE - Static variable in class filenet.vw.api.VWSession
Value of 1. Indicates an Oracle Database.
DATABASE_SQL2000 - Static variable in class filenet.vw.api.VWSession
Value of 2. Indicates a SQL2000 Database.
DATE_FORMAT - Static variable in class filenet.vw.api.VWWorkflowRuntimeId
String representation of the formatting for date values, with a value of:
"MM/dd/yyyy hh:mm:ss".
DAYS - Static variable in class filenet.vw.api.VWTimeUnitType
Value of 3. Specifies days as the time unit.
DB_REINIT_ERR - Static variable in class filenet.vw.api.VWServerException
"Database reinitialized -- all programs must log off and then logon again" Data for this error is stale
DEADLINE_NOT_REACHED - Static variable in class filenet.vw.api.VWQueueElement
Value of 0.  This value indicates that a step element is still waiting to reach a deadline.
DEADLINE_REACHED - Static variable in class filenet.vw.api.VWQueueElement
Value of 2.  This value indicates that a step element has reached a deadline.
DEADLINE_REMINDER_NOTICE - Static variable in class filenet.vw.api.VWQueueElement
Value of 1.  This value indicates whether or not a step element has reached the deadline reminder notice.
delete() - Method in class filenet.vw.api.VWProcess
Deletes all work objects of a running workflow process.
deleteField(String) - Method in class filenet.vw.api.VWAttributeInfo
Deletes a field entry, specified by name.
deleteField(String) - Method in class filenet.vw.api.VWUserInfo
Deletes the named field entry.
deleteField(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Deletes a field definition from the workflow definition.
deleteFieldDefinition(String) - Method in class filenet.vw.api.VWQueueDefinition
Deletes an exposed field from the queue.
deleteFieldDefinition(String) - Method in class filenet.vw.api.VWLogDefinition
Deletes an exposed field from the log.
deleteFieldDefinition(String) - Method in interface filenet.vw.api.IVWTableDefinition
Provides the ability to delete exposed fields from the queue.
deleteFieldDefinition(String) - Method in class filenet.vw.api.VWRosterDefinition
Deletes an exposed field from the roster.
deleteIndexDefinition(String) - Method in class filenet.vw.api.VWQueueDefinition
Deletes an index from this queue, given the index name.
deleteIndexDefinition(String) - Method in class filenet.vw.api.VWLogDefinition
Deletes an index from the log.
deleteIndexDefinition(String) - Method in interface filenet.vw.api.IVWTableDefinition
Provides the ability to delete indexes from this queue.
deleteIndexDefinition(String) - Method in class filenet.vw.api.VWRosterDefinition
Deletes an index from this roster.
DeleteInjectSession(VWRoster, String) - Static method in class filenet.vw.api.VWInjectSessionInfo
Deprecated. Deletes an inject session.
deleteInstruction(int) - Method in class filenet.vw.api.VWCompoundStepDefinition
Deletes an instruction from this compound step definition, specified by the instruction id.
deleteMap(int) - Method in class filenet.vw.api.VWWorkflowDefinition
Deprecated. Replaced by VWWorkflowDefinition.deleteMap(String)
deleteMap(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Deletes the specified map from this workflow definition.
deleteMilestone(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Deletes the specified milestone from this workflow definition.
deleteOperation(String) - Method in class filenet.vw.api.VWQueueDefinition
Deletes an operation from this queue, given the operation name.
deleteParameter(String) - Method in class filenet.vw.api.VWStepDefinition
Deletes a parameter definition from the set of parameter definitions stored in this step.
deleteParameter(String) - Method in class filenet.vw.api.VWOperationDefinition
Deletes a parameter.
deleteRoute(int) - Method in class filenet.vw.api.VWMapNode
Deletes an outbound route from this step.
deleteRuleSet(VWRuleSetDefinition) - Method in class filenet.vw.api.VWWorkflowDefinition
Deletes a rule set definition from this workflow definition.
deleteStep(int) - Method in class filenet.vw.api.VWMapDefinition
Deletes a step from the Workflow Map, using an integer value for the step ID.
deleteStepProcessorInfoDefinition(VWStepProcessorInfoDefinition) - Method in class filenet.vw.api.VWSystemConfiguration
Deletes a step processor info definition.
deleteUserInfo(String) - Method in class filenet.vw.api.VWSystemAdministration
Deletes information about a specified user.
doAbort() - Method in class filenet.vw.api.VWStepElement
Unlocks a work item associated with this step without updating the fields on the work item.
doAbort() - Method in class filenet.vw.api.VWWorkObject
Unlock this work object without updating its fields.
doAbort() - Method in class filenet.vw.api.VWInstructionElement
Unlocks the workflow object associated with the Instruction Element, without updating the workflow object fields.
doDelete(boolean, boolean) - Method in class filenet.vw.api.VWWorkObject
Delete this work object.
doDeleteMany(VWWorkObject[], boolean, boolean) - Static method in class filenet.vw.api.VWWorkObject
Deletes the specified work objects.
doDispatch() - Method in class filenet.vw.api.VWStepElement
Saves changes made to the work object associated with this step element, unlocks the work object, and moves the current step to the next workflow step.
doDispatch() - Method in class filenet.vw.api.VWWorkObject
Saves changes made in this work object, unlocks it, and moves the current step to the next workflow step.
doDispatch() - Method in class filenet.vw.api.VWInstructionElement
Saves changes made to the work object associated with this Instruction Element, unlocks the work object, and moves the current step to the next workflow step.
doLock(boolean) - Method in class filenet.vw.api.VWStepElement
Locks the work item associated with this step element.
doLock(boolean) - Method in class filenet.vw.api.VWWorkObject
Locks the work object.
doLock(boolean) - Method in class filenet.vw.api.VWInstructionElement
Locks a workflow object.
doLockMany(VWInstructionElement[], boolean) - Static method in class filenet.vw.api.VWInstructionElement
Locks Instruction Elements associated with workflow objects in a single call.
doLockMany(VWWorkObject[], boolean) - Static method in class filenet.vw.api.VWWorkObject
Locks multiple work objects in a single call and refreshes them with current information.
doReassign(String, boolean, String) - Method in class filenet.vw.api.VWStepElement
Changes the participant responsible for processing the current step.
doReassign(String, boolean, String) - Method in class filenet.vw.api.VWWorkObject
Delegates the current step assignment associated with this work object to another participant.
doRefresh(boolean, boolean) - Method in class filenet.vw.api.VWStepElement
Fetches an updated version of the instruction to get the latest information.
doRefresh(boolean, boolean) - Method in class filenet.vw.api.VWWorkObject
Retrieves an updated version of the work object to get recent data.
doRefresh(boolean, boolean) - Method in class filenet.vw.api.VWInstructionElement
Fetches the specified Instruction Element to get the most current information.
doReturnToSource() - Method in class filenet.vw.api.VWStepElement
Returns the work item to the queue from which a user originally reassigned or delegated the work item.
doReturnToSource() - Method in class filenet.vw.api.VWWorkObject
Returns the work object to the queue from which it was originally reassigned or delegated.
doSave(boolean) - Method in class filenet.vw.api.VWStepElement
Saves the work item associated with this step element.
doSave(boolean) - Method in class filenet.vw.api.VWWorkObject
Saves this work object.
doSave(boolean) - Method in class filenet.vw.api.VWInstructionElement
Saves the workflow object associated with the Instruction Element.
doSaveMany(VWInstructionElement[]) - Static method in class filenet.vw.api.VWInstructionElement
Saves and updates information for each workflow object specified by the passed array of Instruction Elements.
doSaveMany(VWWorkObject[]) - Static method in class filenet.vw.api.VWWorkObject
Saves information for an array of work objects.
doTerminate() - Method in class filenet.vw.api.VWWorkObject
Terminate this work object.
doTerminate() - Method in class filenet.vw.api.VWInstructionElement
Terminates the workflow object associated with the Instruction Element.
doTerminateMany(VWInstructionElement[]) - Static method in class filenet.vw.api.VWInstructionElement
Terminates workflow objects associated with the passed Instruction Elements.
doTerminateMany(VWWorkObject[]) - Static method in class filenet.vw.api.VWWorkObject
Terminates the specified work objects.
doUnlockMany(VWInstructionElement[], boolean, boolean) - Static method in class filenet.vw.api.VWInstructionElement
Unlocks the array of workflow objects specified by the passed Instruction Elements.
doUnlockMany(VWStepElement[], boolean, boolean) - Static method in class filenet.vw.api.VWStepElement
Unlocks an array of step elements.
doUnlockMany(VWWorkObject[], boolean, boolean) - Static method in class filenet.vw.api.VWWorkObject
Unlocks an array of work objects.
DS_TYPE_LDAP - Static variable in class filenet.vw.api.VWSession
Value of 1, representing a Lightweight Directory Access Protocol (LDAP) database security type.
DS_TYPE_SEC - Static variable in class filenet.vw.api.VWSession
Value of 0, representing a FileNet database security type.
DTBOOLEAN - Static variable in class filenet.vw.api.VWQueueElement
Value of 2.  This value indicates that the type of the data in a workflow object field data type is Boolean.
DTINTEGER - Static variable in class filenet.vw.api.VWQueueElement
Value of 1.  This value indicates that the type of the data in a workflow object field data type is integer.
DTSTRING - Static variable in class filenet.vw.api.VWQueueElement
Value of 0.  This value indicates that the type of the data in a workflow object field data type is string.

F

FETCH_TYPE_INSTRUCTION_ELEMENT - Static variable in class filenet.vw.api.VWFetchType
Value of 2. Return instruction elements by passing the integer as a parameter in the VWQueue.createQuery() method.
FETCH_TYPE_QUEUE_ELEMENT - Static variable in class filenet.vw.api.VWFetchType
Value of 3. Return queue elements by passing the integer as a parameter in the VWQueue.createQuery() method.
FETCH_TYPE_ROSTER_ELEMENT - Static variable in class filenet.vw.api.VWFetchType
Value of 4. Return roster elements by passing the integer as a parameter in the VWRoster.createQuery() method.
FETCH_TYPE_STEP_ELEMENT - Static variable in class filenet.vw.api.VWFetchType
Value of 5. Return step elements by passing the integer as a parameter in the VWQueue.createQuery() method.
FETCH_TYPE_WORKOBJECT - Static variable in class filenet.vw.api.VWFetchType
Value of 1. Return work items by passing the integer as a parameter in the VWQueue.createQuery() or VWRoster.createQuery() methods.
fetchAttributes(int) - Method in class filenet.vw.api.VWSession
Fetches system-wide or region-specific attribute information from the Process Engine for the current logged-on session.
fetchCount() - Method in class filenet.vw.api.VWRosterQuery
Returns the number of records that can be retrieved for the current VWRosterQuery object.
fetchCount() - Method in class filenet.vw.api.VWQueueQuery
Gets the integer value indicating the number of records that can be retrieved, using this queueQuery object.
fetchCount() - Method in class filenet.vw.api.VWRoster
Gets an integer that indicates the number of work items in the roster.
fetchCount() - Method in class filenet.vw.api.VWLogQuery
Gets the integer value indicating the number of records that can be retrieved, using this logQuery definition.
fetchCount() - Method in class filenet.vw.api.VWQueue
Gets the integer value indicating the queue depth.
fetchCurrentUserInfo() - Method in class filenet.vw.api.VWSession
Gets information about the user logged on to this session.
fetchEventLog(String) - Method in class filenet.vw.api.VWSession
Retrieves an event log, given an associated event log name.
fetchEventLogNames() - Method in class filenet.vw.api.VWSession
Retrieves the name of every event log in the Process Engine system.
fetchFilteredWorkflowHistory(int, int) - Method in class filenet.vw.api.VWProcess
Fetches step history data for the current workflow process that is associated with this workflow map ID, specified to be either completed step history only, or all history data.
fetchFilteredWorkflowMilestones(int, boolean, boolean) - Method in class filenet.vw.api.VWProcess
Fetches the milestone data for this workflow process, in which the milestone events have a level property less than or equal to the level parameter passed to this method.
fetchIndexFields() - Method in class filenet.vw.api.VWQueue
Deprecated. Replaced by VWQueue.fetchQueueDefinition()
fetchIndexKeyFields(String) - Method in class filenet.vw.api.VWQueue
Deprecated. Replaced by VWQueue.fetchQueueDefinition()
fetchInstructionElement(boolean, boolean) - Method in class filenet.vw.api.VWQueueElement
Fetches the corresponding instruction element for the workflow object associated with the queue element.
fetchInstructionElement(boolean, boolean) - Method in class filenet.vw.api.VWWorkObject
Fetches the Instruction Element information associated with this work object.
fetchInstructionElement(boolean, boolean) - Method in class filenet.vw.api.VWRosterElement
Fetches the instruction element that corresponds to the roster element.
fetchInstructionElements(int) - Method in class filenet.vw.api.VWQueueQuery
Deprecated. Replaced by VWQueueQuery.next()
fetchIsGroup(String[]) - Method in class filenet.vw.api.VWSession
Determines whether or not names passed in are groups.
fetchLaunchStepProcessor(String) - Method in class filenet.vw.api.VWSession
Retrieves a launch step processor, given an associated workflow definition ID.
fetchLockedStatus() - Method in class filenet.vw.api.VWWorkObject
Retrieves the lock status of the work object.
fetchLockedStatus() - Method in class filenet.vw.api.VWInstructionElement
Checks the status of the workflow object.
fetchLogDefinition() - Method in class filenet.vw.api.VWLog
Fetches the log definition.
fetchOperationNames() - Method in class filenet.vw.api.VWQueue
Fetches the list of all the Operation names for this queue.
fetchProcess() - Method in class filenet.vw.api.VWStepElement
Retrieves the workflow process that contains this step element object.
fetchProcess() - Method in class filenet.vw.api.VWWorkObject
Retrieves the workflow process that contains this work object.
fetchProcess(int, int, String) - Method in class filenet.vw.api.VWSession
Retrieves the workflow process containing this work object.
fetchQueueDefinition() - Method in class filenet.vw.api.VWQueue
Fetches the definition for this queue.
fetchQueueElements(int) - Method in class filenet.vw.api.VWQueueQuery
Deprecated. Replaced by VWQueueQuery.next()
fetchQueueFields() - Method in class filenet.vw.api.VWQueue
Deprecated. Replaced by VWQueue.fetchQueueDefinition()
fetchQueueNames(int) - Method in class filenet.vw.api.VWSession
Retrieves the names of every work queue accessible through the session, within the queue type scope specified.
fetchReachedWorkflowMilestones(int) - Method in class filenet.vw.api.VWProcess
Fetches milestone events with a level property less than or equal to the value of the theLevel parameter passed to this method.
fetchReturnStackElements() - Method in class filenet.vw.api.VWWorkObject
Retrieves work object return stack.
fetchRosterDefinition() - Method in class filenet.vw.api.VWRoster
Fetches the definition for this roster.
fetchRosterElements(int) - Method in class filenet.vw.api.VWRosterQuery
Fetches a specified number of roster elements.
fetchRosterNames(boolean) - Method in class filenet.vw.api.VWSession
Retrieves the name of every roster in the system.
fetchStatistics(Date, Date, int) - Method in class filenet.vw.api.VWRoster
Fetches statistical information for the roster, given a start and stop time.
fetchStatistics(Date, Date, int) - Method in class filenet.vw.api.VWQueue
Fetches statistical information for the queue, given a start and stop time.
fetchStepElement() - Method in class filenet.vw.api.VWWorkObject
Fetches the current step in the workflow process.
fetchStepElement(boolean, boolean) - Method in class filenet.vw.api.VWQueueElement
Fetches the current step in the workflow process.
fetchStepHistory(int) - Method in class filenet.vw.api.VWWorkflowHistory
Fetches the latest history of the step, given the step ID.
fetchStepProcessorInfo() - Method in class filenet.vw.api.VWQueueElement
Fetches the step processor object containing the information needed to launch a workflow.
fetchStepProcessorInfo() - Method in class filenet.vw.api.VWWorkObject
Retrieves the step processor information necessary for launching a step.
fetchStepProcessorInfo(String) - Method in class filenet.vw.api.VWSession
Retrieves a step processor object defined for the current session and workflow definition, given the step processor ID.
fetchStepProcessors(int) - Method in class filenet.vw.api.VWSession
Retrieves a list of step processor objects defined for the current session and workflow definition.
fetchSystemAdministration() - Method in class filenet.vw.api.VWSession
Gets system administration information for the Process Engine.
fetchSystemConfiguration() - Method in class filenet.vw.api.VWSession
Gets system configuration information for a system.
fetchUserGroups(int) - Method in class filenet.vw.api.VWSession
Gets group names for the Process Engine.
fetchUserInfo(String) - Method in class filenet.vw.api.VWSystemAdministration
Fetches information about a specified user.
fetchUserInfo(String) - Method in class filenet.vw.api.VWSession
Gets general user information about a specified user.
fetchUsers(int, boolean) - Method in class filenet.vw.api.VWSession
Fetches a collection of all user names defined on the Process Engine.
fetchWorkClassNames(boolean) - Method in class filenet.vw.api.VWSession
Retrieves the name of every work class in the system.
fetchWorkflowDefinition() - Method in class filenet.vw.api.VWProcess
Deprecated. Replaced by fetchWorkflowDefinition(boolean), which can handle workflow definitions that reference work classes from a previous version of Process that was known as Panagon Visual WorkFlo. This method also can include references to workflow definitions that need to explicitly incorporate a default terminate or malfunction map.
fetchWorkflowDefinition(boolean) - Method in class filenet.vw.api.VWProcess
Fetches the workflow definition for this workflow process.
fetchWorkflowDefinition(int, String) - Method in class filenet.vw.api.VWSession
Deprecated. Replaced by VWSession.fetchWorkflowDefinition(int,String, boolean) which can handle a workflow definition that references a work class from a previous version of Process that was known as Panagon Visual WorkFlo. It also can represent a workflow definition that explicitly incorporates default terminate or malfunction maps.
fetchWorkflowDefinition(int, String, boolean) - Method in class filenet.vw.api.VWSession
Fetches a workflow definition, given the workspace ID and the work class name or the version String.
fetchWorkflowHistory(int) - Method in class filenet.vw.api.VWProcess
Fetches the history data for this workflow process that is associated with this workflow instruction sheet ID.
fetchWorkflowSignature(String) - Method in class filenet.vw.api.VWSession
Returns the workflow signature, given an associated work class name or workflow version.
fetchWorkObject(boolean, boolean) - Method in class filenet.vw.api.VWStepElement
Fetches the work item associated with this step element.
fetchWorkObject(boolean, boolean) - Method in class filenet.vw.api.VWQueueElement
Fetches the workflow object associated with this queue element.
fetchWorkObject(boolean, boolean) - Method in class filenet.vw.api.VWRosterElement
Fetches the work object that corresponds to this roster element.
fetchWorkObject(boolean, boolean) - Method in class filenet.vw.api.VWInstructionElement
Fetches a workflow object specified in the Instruction Element.
fetchWorkObjects(int) - Method in class filenet.vw.api.VWRosterQuery
Deprecated. Replaced by VWRosterQuery.next()
fetchWorkObjects(int) - Method in class filenet.vw.api.VWQueueQuery
Deprecated. Replaced by VWQueueQuery.next()
FIELD_SYSTEM_DEFINED - Static variable in class filenet.vw.api.VWStepElement
Value of 2. Indicates that the field is a system-defined field.
FIELD_SYSTEM_DEFINED - Static variable in class filenet.vw.api.VWWorkObject
Value of 2. Indicates that the data field was created by the system.
FIELD_TYPE_ATTACHMENT - Static variable in class filenet.vw.api.VWFieldType
Value of 32. Indicates a workflow field of type Attachment(an attached document).
FIELD_TYPE_BOOLEAN - Static variable in class filenet.vw.api.VWFieldType
Value of 4. Indicates a workflow field of type java.lang.Boolean.
FIELD_TYPE_FLOAT - Static variable in class filenet.vw.api.VWFieldType
Value of 8. Indicates a workflow field of type java.lang.Double.
FIELD_TYPE_INT - Static variable in class filenet.vw.api.VWFieldType
Value of 1. Indicates a workflow field of type java.lang.Integer.
FIELD_TYPE_PARTICIPANT - Static variable in class filenet.vw.api.VWFieldType
Value of 64. Indicates a workflow field of type participant.
FIELD_TYPE_STRING - Static variable in class filenet.vw.api.VWFieldType
Value of 2. Indicates a workflow field of type java.lang.String.
FIELD_TYPE_TIME - Static variable in class filenet.vw.api.VWFieldType
Value of 16. Indicates a workflow field of type java.util.Date.
FIELD_USER_AND_SYSTEM_DEFINED - Static variable in class filenet.vw.api.VWStepElement
Value of 3. Indicates that the field is both a user- and system-defined field.
FIELD_USER_AND_SYSTEM_DEFINED - Static variable in class filenet.vw.api.VWWorkObject
Value of 3. Indicates that the data field was created by the system but is being controlled by the user.
FIELD_USER_DEFINED - Static variable in class filenet.vw.api.VWStepElement
Value of 1. Indicates that the field is a user-defined field.
FIELD_USER_DEFINED - Static variable in class filenet.vw.api.VWWorkObject
Value of 1. Indicates that the data field was created by the user.
filenet.vw.api - package filenet.vw.api
 
FILTER_COMPLETED_STEP_HISTORY - Static variable in class filenet.vw.api.VWProcess
Value of 1: use this in the in the filterFlags parameter of the VWProcess.fetchFilteredWorkflowHistory(int, int) method to specify only completed step history data to be returned.
FILTER_NONE - Static variable in class filenet.vw.api.VWProcess
Value of 0: use this in the filterFlags parameter of the VWProcess.fetchFilteredWorkflowHistory(int, int) method to specify that all step history data be returned.
findField(String) - Method in class filenet.vw.api.VWWorkflowSignature
Finds a field definition in the list of field definitions in this VWWorkflowSignature.
findGroups(String, int, int, int) - Method in class filenet.vw.api.VWSession
Fetches a collection of all group names defined within the default LDAP domain, matching them for inclusion in the result collection, according to this method's search pattern and search type arguments.
findUsers(String, int, int, int) - Method in class filenet.vw.api.VWSession
Fetches a collection of all user names defined within the default LDAP domain, matching them for inclusion in the result collection, according to this method's search pattern and search type arguments.

G

getAction() - Method in class filenet.vw.api.VWInstructionDefinition
Gets the action.
getActiveRouters(String) - Static method in class filenet.vw.api.VWSession
For the Application Engine only, this method lists the names of the routers configured on the Process Engine's server.
getApplicationName() - Method in class filenet.vw.api.VWStepProcessorInfo
Gets the application name, which is the Java application class that can be invoked, or the empty String if the application type is HTML.
getApplicationName() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Gets the application name.
getAppType() - Method in class filenet.vw.api.VWStepProcessorInfo
Gets the application type, either URL or Java, associated with this step processor.
getAppType() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Gets the application type, either URL or Java, associated with this step processor.
getAssignments() - Method in class filenet.vw.api.VWEventDefinition
Gets the assignments property value for the event.
getAttachmentDescription() - Method in class filenet.vw.api.VWAttachment
Gets the description for an attachment.
getAttachmentName() - Method in class filenet.vw.api.VWAttachment
Gets the document name associated with this attachment.
getAttributeInfo() - Method in class filenet.vw.api.VWQueueDefinition
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
getAttributeInfo() - Method in class filenet.vw.api.VWSystemAdministration
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
getAttributeInfo() - Method in class filenet.vw.api.VWStepDefinition
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
getAttributeInfo() - Method in class filenet.vw.api.VWSystemConfiguration
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
getAttributeInfo() - Method in class filenet.vw.api.VWOperationDefinition
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
getAttributeInfo() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
getAttributeNames() - Method in class filenet.vw.api.VWAttributeInfo
Gets the attribute names.
getAuthorTool() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the value of this workflow definition's authorTool property.
getAverageLifeSpanChildWO() - Method in class filenet.vw.api.VWRosterStats
Gets the average life span of child work objects since the beginning of the time interval.
getAverageLifeSpanOfWO() - Method in class filenet.vw.api.VWRosterStats
Gets the average life span of work objects since the beginning of the time interval.
getAverageLifeSpanParentWO() - Method in class filenet.vw.api.VWRosterStats
Gets the average life span of parent work objects since the beginning of the time interval.
getAverageNumberOfActiveChildWO() - Method in class filenet.vw.api.VWRosterStats
Gets the ratio of the sum of child work objects that are alive in the system to the number of samples taken.
getAverageNumberOfActiveParentWO() - Method in class filenet.vw.api.VWRosterStats
Gets the ratio of the sum of parent work objects that are alive in the system to the number of samples taken.
getAverageNumberOfActiveWO() - Method in class filenet.vw.api.VWRosterStats
Gets the ratio of the sum of work objects that are alive in the system to the number of samples taken.
getAverageProcessedWO() - Method in class filenet.vw.api.VWQueueStats
Gets the ratio of the summation of sample counts of the processed work objects to the number of samples.
getAverageQueueDelay() - Method in class filenet.vw.api.VWQueueStats
Gets the ratio of the total of the time periods (in the requested time units) work objects stayed in a queue, to the number of work objects dequeued during the evaluation period.
getAverageQueueDepth() - Method in class filenet.vw.api.VWQueueStats
Gets the ratio of the summation of queue depths, summed over the sample periods, to the number of samples.
getAverageThroughput() - Method in class filenet.vw.api.VWQueueStats
Gets the ratio of the number of work objects dequeued to the number of time units spanning the evaluation period.
getAverageWOLocked() - Method in class filenet.vw.api.VWQueueStats
Gets a ratio of the summation of the sample counts of the locked work objects to the number of samples as a ratio.
getAverageWOProcessingTime() - Method in class filenet.vw.api.VWQueueStats
Gets the per-time-unit average processing time for a work object.
getBaseWorkClassName() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the value of this workflow definition's base work class name, which is the name of the work class from which this workflow definition will inherit, at transfer or initialization.
getBoundUserId() - Method in class filenet.vw.api.VWParticipantHistory
Gets an integer value for the bound user ID.
getBufferSize() - Method in class filenet.vw.api.VWStepHistory
Retrieves the maximum number of elements to return in a fetch.
getBufferSize() - Method in class filenet.vw.api.VWWorkflowHistory
Retrieves the maximum number of elements to return in a fetch.
getBufferSize() - Method in class filenet.vw.api.VWProcess
Gets the value of the buffer size setting.
getBufferSize() - Method in class filenet.vw.api.VWRoster
Gets an integer value indicating the maximum number of elements to return in a fetch. The default number is 50.
getBufferSize() - Method in class filenet.vw.api.VWQueue
Gets the maximum number of elements set by the user to return in a fetch.
getBufferSize() - Method in class filenet.vw.api.VWStepWorkObjectHistory
Retrieves the maximum number of elementsto return in a fetch.
getBufferSize() - Method in class filenet.vw.api.VWStepOccurrenceHistory
Retrieves the maximum number of elements to return in a fetch.
getCallISName() - Method in class filenet.vw.api.VWEventDefinition
Gets the name of the instruction sheet (map) which will be called when this event occurs.
getCallMap() - Method in class filenet.vw.api.VWStepElement
Gets the name of the workflow map you set using the setCallMap method.
getCallMap() - Method in class filenet.vw.api.VWWorkObject
Gets the name of the workflow map you specified in the setCallMap method.
getCanAssign() - Method in class filenet.vw.api.VWFieldDefinition
Gets the value of the canAssign flag, which indicates whether or not this data field can be a left-hand value in an assignment statement.
getCanReassign() - Method in class filenet.vw.api.VWStepElement
Determines whether the work item can be reassigned.
getCanReassign() - Method in class filenet.vw.api.VWStepDefinition
Indicates whether the user can reassign this step.
getCanReturnToSource() - Method in class filenet.vw.api.VWStepElement
Determines whether the work item can be returned to the queue from which the user delegated or reassigned it.
getCanViewHistory() - Method in class filenet.vw.api.VWStepElement
Determines whether this step element's history can be viewed through the step processor.
getCanViewHistory() - Method in class filenet.vw.api.VWStepDefinition
the user can view the history at the current step.
getCanViewStatus() - Method in class filenet.vw.api.VWStepElement
Determines whether this step element can be viewed through the tracker application.
getCanViewStatus() - Method in class filenet.vw.api.VWStepDefinition
Gets the current value of the flag that indicates whether or not the user can view the status of the current step.
getCauseClassName() - Method in class filenet.vw.api.VWException
 
getCauseDescription() - Method in class filenet.vw.api.VWException
 
getChildCreationRate() - Method in class filenet.vw.api.VWRosterStats
Gets the rate at which the application created child work objects in the time interval, based on the time units entered.
getChildrenGrowRate() - Method in class filenet.vw.api.VWRosterStats
Gets the rate at which child work objects grew in the system; the rate indicates the relationship as a ratio of the creation rate to the termination rate.
getChildTerminationRate() - Method in class filenet.vw.api.VWRosterStats
Gets the rate at which the application terminated child work objects in the time interval, based on the time units entered.
getComment() - Method in class filenet.vw.api.VWStepElement
Gets the comment for this step.
getComment() - Method in class filenet.vw.api.VWWorkObject
Retrieves the comment for this step.
getComments() - Method in class filenet.vw.api.VWParticipantHistory
Gets the comments entered by the participant for this step.
getComparisonOperator() - Method in class filenet.vw.api.VWEventDefinition
Gets this event's comparison operator.
getCompCall() - Method in class filenet.vw.api.VWRollbackInstruction
Get the compensation call instruction sheet name for this rollback operation.
getCompletionDate() - Method in class filenet.vw.api.VWParticipantHistory
Get the date on which the participant completed the step.
getCompletionDate() - Method in class filenet.vw.api.VWStepOccurrenceHistory
Gets the date on which the all participants completed the work at this step occurrence.
getCompletionUser() - Method in class filenet.vw.api.VWParticipantHistory
Gets the participant who completed, delegated, reassigned, returned or terminated the workflow step.
getCondition() - Method in class filenet.vw.api.VWRouteDefinition
Gets the value contained in the condition property.
getContainingStepId(int) - Method in class filenet.vw.api.VWMapDefinition
Gets the ID of the compound step which contains an instruction whose id is passed as a parameter to this method.
getCopy(VWStepProcessorInfoDefinition) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Copies and cleans a VWStepProcessorInfoDefinition object that may have a "dirty bit-set".
getCount() - Method in class filenet.vw.api.VWRoster
Deprecated. Replaced by VWRoster.fetchCount()
getCount() - Method in class filenet.vw.api.VWQueue
Deprecated. Replaced by VWQueue.fetchCount()
getCreateSecurity() - Method in class filenet.vw.api.VWRosterDefinition
Lists users and/or groups who have Create access to the roster.
getCurrentMapName() - Method in class filenet.vw.api.VWStepElement
Gets the name of the map for the step.
getCurrentQueueDepth() - Method in class filenet.vw.api.VWQueueStats
Gets a number representing the queue depth at a sample point, at the time the method is processed.
getCurrentQueueName() - Method in class filenet.vw.api.VWStepElement
Gets the name of the queue on which the work item resides.
getCurrentQueueName() - Method in class filenet.vw.api.VWWorkObject
Retrieves the queue in which this work object resides.
getCurrentVersion() - Method in class filenet.vw.api.VWSession
Gets the current version of the Process Engine API.
getCurrentWOLocked() - Method in class filenet.vw.api.VWQueueStats
Gets a double-precision number that is the count of the number of work objects locked at the sample point.
getDatabaseType() - Method in class filenet.vw.api.VWSession
Gets the database configuration type for the workflow database.
getDataFields() - Method in class filenet.vw.api.VWQueueElement
Gets a list of data fields supported by this queue element.
getDataFields() - Method in class filenet.vw.api.VWRosterElement
Lists exposed data fields this roster element supports.
getDataFields() - Method in class filenet.vw.api.VWLogElement
Lists the data fields supported by the log element.
getDataFields() - Method in class filenet.vw.api.VWNewWorkObject
Deprecated. Lists the data fields supported by the new work object.
getDataFields(int, int) - Method in class filenet.vw.api.VWWorkObject
Retrieves a list of all data fields this work object supports.
getDataType() - Method in class filenet.vw.api.VWParameterDefinition
Gets the data type of the parameter.
getDateReceived() - Method in class filenet.vw.api.VWParticipantHistory
Gets a date value, which indicates when the participant received the step.
getDateReceived() - Method in class filenet.vw.api.VWStepElement
Gets the date on which the user received this step.
getDateReceived() - Method in class filenet.vw.api.VWWorkObject
Retrieves the date on which you received this work object.
getDateReceived() - Method in class filenet.vw.api.VWStepOccurrenceHistory
Gets the date on which the participant first received the work.
getDeadline() - Method in class filenet.vw.api.VWStepElement
Gets the date value that represents the date by which the step must be completed.
getDeadline() - Method in class filenet.vw.api.VWWorkObject
Retrieve the date by which the step should be completed.
getDeadline() - Method in class filenet.vw.api.VWStepDefinition
Gets the deadline property value for the step.
getDeadline() - Method in class filenet.vw.api.VWWorkflowDefinition
Retrieves the value of the deadline property for this workflow definition.
getDeadlineExpr() - Method in class filenet.vw.api.VWStepDefinition
Retrieves the value of the deadline expression property for this step definition.
getDeadlineMap() - Method in class filenet.vw.api.VWStepDefinition
Gets the name of the map to be called when the step deadline expires for this step definition.
getDefaultLogDefinition() - Method in class filenet.vw.api.VWSystemConfiguration
Gets the default definition for event logging.
getDefaultRouter(String) - Static method in class filenet.vw.api.VWSession
For the Application Engine only, this method determines the name of the default router configured on the Process Engine's server.
getDefaultSecurityDomain() - Method in class filenet.vw.api.VWSession
Returns the name of the default security domain.
getDefaultWebApplication() - Method in class filenet.vw.api.VWSession
Gets the default Web Application ID for a logged-on session; the default web application is applied to an initial transfer to a region.
getDequeuedRate() - Method in class filenet.vw.api.VWQueueStats
Gets the ratio of the dequeued work objects to the number of time units in the evaluation period.
getDescription() - Method in class filenet.vw.api.VWQueueDefinition
Gets the description associated with the queue definition.
getDescription() - Method in class filenet.vw.api.VWMapNode
Gets the value of the current node's description property.
getDescription() - Method in class filenet.vw.api.VWMapDefinition
Gets the description of the Workflow Map.
getDescription() - Method in class filenet.vw.api.VWParameterDefinition
Gets the value of the description property.
getDescription() - Method in class filenet.vw.api.VWParameter
Gets the description of the parameter.
getDescription() - Method in class filenet.vw.api.VWLogDefinition
Gets the string description for this log definition.
getDescription() - Method in interface filenet.vw.api.IVWTableDefinition
Provides the description for this table definition.
getDescription() - Method in class filenet.vw.api.VWFieldDefinition
Gets the description String for the data field. The String is contained in the description property of the data field.
getDescription() - Method in class filenet.vw.api.VWOperationDefinition
Returns the description of this operation.
getDescription() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the value in the description property of this workflow definition.
getDescription() - Method in class filenet.vw.api.VWRosterDefinition
Provides the description for this roster definition.
getDestinationStep() - Method in class filenet.vw.api.VWRouteDefinition
Gets the information contained in the object that represents the step destination.
getDestinationStepId() - Method in class filenet.vw.api.VWRouteDefinition
Gets the integer value of the stepId property for the step destination.
getDuration() - Method in class filenet.vw.api.VWLogElement
Gets the duration of the logging period.
getElementType() - Method in class filenet.vw.api.VWRosterQuery
Gets the fetch type for the VWRosterQuery object.
getElementType() - Method in class filenet.vw.api.VWQueueQuery
Gets the fetch type of this VWQueueQuery object.
getEMailAddress() - Method in class filenet.vw.api.VWUserInfo
Gets the email address of the current user.
getEndTime() - Method in class filenet.vw.api.VWRosterStats
Gets the time the evaluated request completed on the server.
getEndTime() - Method in class filenet.vw.api.VWQueueStats
Gets the time the evaluated request completed on the server.
getErrorMessageText() - Method in class filenet.vw.api.VWReturnStackElement
Gets the error message text for this stack object.
getErrorNumber() - Method in class filenet.vw.api.VWReturnStackElement
Gets the error number for this stack object.
getErrors() - Method in class filenet.vw.api.VWTransferResult
Retrieves the errors returned by a transfer operation.
getErrorType() - Method in class filenet.vw.api.VWValidationError
Retrieves the value in the errorType property of this validation error.
getEvaluationTime() - Method in class filenet.vw.api.VWRosterStats
Gets the timestamp for the evaluation period for the request.
getEvaluationTime() - Method in class filenet.vw.api.VWQueueStats
Gets the time stamp for the time this request was evaluated on the server.
getEventLogName() - Method in class filenet.vw.api.VWProcess
Gets the event log name of this workflow process.
getEventLogName() - Method in class filenet.vw.api.VWWorkflowSignature
Returns the event log name.
getEventLogName() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets this workflow definition's event log name, which applies to the transfer or initialization of event logs.
getEventNumLoc() - Method in class filenet.vw.api.VWWFEInstruction
Get the value of this instruction's eventNumLoc expression property.
getEvents() - Method in class filenet.vw.api.VWWFEInstruction
Gets the events contained in this VWWFEInstruction instance.
getEventType() - Method in class filenet.vw.api.VWLogElement
Gets the event type of the log record.
getExceptionDescription() - Method in class filenet.vw.api.VWStepElement
Gets the value the workflow author set for description of the workflow exception.
getExceptionDescription() - Method in class filenet.vw.api.VWWorkObject
Gets the value the workflow author set for the description of the Process exception.
getExceptionDescription() - Method in class filenet.vw.api.VWInstructionElement
Returns the string value the user set as the description of the VWException.
getExceptionInstructionSheet() - Method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.getExceptionMap()
getExceptionInstructionSheet() - Method in class filenet.vw.api.VWInstructionElement
Returns the string value the user set as the name of the exception instruction sheet.
getExceptionMap() - Method in class filenet.vw.api.VWStepElement
Gets the name of the workflow exception that corresponds to the workflow map.
getExceptionMap() - Method in class filenet.vw.api.VWWorkObject
Retrieves the name of the Process Engine exception that corresponds to the workflow map.
getExceptionMap() - Method in class filenet.vw.api.VWInstructionElement
Gets the exception workflow map for the workflow object associated with the Instruction Element.
getExposedFields() - Method in class filenet.vw.api.VWSystemConfiguration
Returns all the exposed fields on the queues, the rosters, and the logs.
getField(String) - Method in class filenet.vw.api.VWWorkflowSignature
Reserved for FileNet use.
getField(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the definition of a data field from this workflow definition.
getFieldDefinitions() - Method in class filenet.vw.api.VWWorkflowSignature
Returns an array of VWFieldDefinition objects that contains the field list.
getFieldMode(String) - Method in class filenet.vw.api.VWInstructionElement
Specifies the parameter mode for the specified field as IN, OUT, or INOUT.
getFieldNames() - Method in class filenet.vw.api.VWIndexDefinition
Returns field names of the concatenated index.
getFieldNames() - Method in class filenet.vw.api.VWQueueElement
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.
getFieldNames() - Method in class filenet.vw.api.VWWorkObject
Retrieves the names of the data fields this work object supports.
getFieldNames() - Method in class filenet.vw.api.VWRosterElement
Lists the system-defined field names and user-defined exposed field names supported by the roster element.
getFieldNames() - Method in class filenet.vw.api.VWLogElement
Lists the system- and user-defined log element field names.
getFieldNames() - Method in class filenet.vw.api.VWInstructionElement
Lists the field names for the Instruction Element parameters.
getFieldNames() - Method in class filenet.vw.api.VWNewWorkObject
Deprecated. Lists data field names for this work object.
getFields() - Method in class filenet.vw.api.VWQueueDefinition
Lists the exposed field definitions for the queue definition.
getFields() - Method in class filenet.vw.api.VWLogDefinition
Lists exposed field definitions for the log definition.
getFields() - Method in interface filenet.vw.api.IVWTableDefinition
Provides an array of exposed field definitions for this queue definition.
getFields() - Method in class filenet.vw.api.VWWorkflowSignature
Reserved for FileNet use.
getFields() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the set of fields associated with this workflow definition.
getFields() - Method in class filenet.vw.api.VWRosterDefinition
Lists exposed field definitions for this roster definition.
getFieldSourceType() - Method in class filenet.vw.api.VWExposedFieldDefinition
Gets the search data source field type.
getFieldType() - Method in class filenet.vw.api.VWExposedFieldDefinition
Gets the search data field type.
getFieldType() - Method in class filenet.vw.api.VWParameter
Gets the field type for the parameter.
getFieldType() - Method in interface filenet.vw.api.IVWField
Get the value of the field's fieldType property.
getFieldType() - Method in class filenet.vw.api.VWDataField
Gets an integer value associated with a valid data field type.
getFieldType() - Method in class filenet.vw.api.VWFieldDefinition
Gets the integer value that represents the field's field type.
getFieldType(String) - Method in class filenet.vw.api.VWAttributeInfo
Returns the field type of the input field name.
getFieldType(String) - Method in class filenet.vw.api.VWUserInfo
Returns the field type of the input field name.
getFieldValue(String) - Method in class filenet.vw.api.VWAttributeInfo
Gets the object value for the input field name.
getFieldValue(String) - Method in class filenet.vw.api.VWQueueElement
Gets the value of a specific field.
getFieldValue(String) - Method in class filenet.vw.api.VWWorkObject
Retrieves the value of a data field.
getFieldValue(String) - Method in class filenet.vw.api.VWRosterElement
Gets the value of a field in the roster element.
getFieldValue(String) - Method in class filenet.vw.api.VWLogElement
Gets the value of user-defined field names.
getFieldValue(String) - Method in class filenet.vw.api.VWInstructionElement
Gets the value of the specified field.
getFieldValue(String) - Method in class filenet.vw.api.VWNewWorkObject
Deprecated. Gets the value of the specified data field.
getFieldValue(String) - Method in class filenet.vw.api.VWUserInfo
Gets the object value for the input field name.
getFTagExpression() - Method in class filenet.vw.api.VWWorkflowSignature
Returns a string that is the F_Tag expression.
getFTagType() - Method in class filenet.vw.api.VWWorkflowSignature
Returns an integer that is the F_Tag type.
getHeight() - Method in class filenet.vw.api.VWStepProcessorInfo
Gets the height, in pixels, specified for the step processor.
getHeight() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Gets the height of the step processor, specified in pixels.
getId() - Method in class filenet.vw.api.VWValidationError
Deprecated. Replaced by VWValidationError.getStepId(), VWMapDefinition.getMapId(), and VWValidationError.getSubStepId() in combination. For compatibility, this method returns a Step ID, but the use of sub-maps in the workflow definition means that a Step ID alone is no longer sufficient to locate the object causing a validation error.

Note An error in a simple step requires the Step ID and the Map ID; an error in a compound step instruction requires a Map ID, a Step ID, and a sub-step ID.

getId() - Method in class filenet.vw.api.VWAttachment
Gets the object or document ID for the attachment.
getId() - Method in class filenet.vw.api.VWStepProcessorInfo
Gets the ID associated with this step processor information.
getId() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Gets the ID associated with this step processor's information.
getIgnoreInvalidUsers() - Method in class filenet.vw.api.VWStepDefinition
Gets the current value of the flag which determines how an invalid step participant will be treated at runtime.
getIndexes() - Method in class filenet.vw.api.VWQueueDefinition
Lists the index definitions for the queue definition.
getIndexes() - Method in class filenet.vw.api.VWLogDefinition
Lists index definitions for the log definition.
getIndexes() - Method in interface filenet.vw.api.IVWTableDefinition
Provides an array of index definitions for this queue definition
getIndexes() - Method in class filenet.vw.api.VWRosterDefinition
Lists index definitions for this roster definition.
getInfo() - Method in class filenet.vw.api.VWValidationError
Retrieves detailed information regarding the validation error, such as the name of a field or a parameter.
getInitialNumberOfQueued() - Method in class filenet.vw.api.VWQueueStats
Gets the initial number of work objects in the queue at the beginning of the time evaluation period.
getInitialNumberOfWO() - Method in class filenet.vw.api.VWRosterStats
Gets the number of work objects at the beginning of the time interval.
getInjectSessionInfo(String, boolean) - Method in class filenet.vw.api.VWRoster
Deprecated. Replaced by VWSession.createLiveWorkObject(String[], Object[], String, int) and VWCreateLiveWOResult.
GetInjectSessionInfo(VWRoster, String, boolean) - Static method in class filenet.vw.api.VWInjectSessionInfo
Deprecated. Gets status information on the specified inject session.
getInstructionId() - Method in class filenet.vw.api.VWInstructionDefinition
Gets the instruction id.
getInstructions() - Method in class filenet.vw.api.VWCompoundStepDefinition
Gets the instructions contained in this VWCompoundStepDefinition instance.
getInstructionSheetId() - Method in class filenet.vw.api.VWMilestoneElement
Gets the instruction sheet ID of the instruction sheet where the milestone event occurred.
getInstructionSheetName() - Method in class filenet.vw.api.VWQueueElement
Gets the name of the instruction sheet of the workflow object.
getInstructionSheetName() - Method in class filenet.vw.api.VWWorkObject
Retrieves the name of the instruction sheet containing the instruction the work object is currently processing.
getInstructionSheetName() - Method in class filenet.vw.api.VWLogElement
Gets the name of the instruction sheet for the work object, if an instruction sheet that is associated with the log element exists.
getInstructionSheetName() - Method in class filenet.vw.api.VWMilestoneElement
Gets the instruction sheet name of the instruction sheet where the milestone event occurred.
getInstructionSheetNames() - Method in class filenet.vw.api.VWWorkflowSignature
Returns an array of strings that holds the instruction sheet names list.
getIsAltered() - Method in class filenet.vw.api.VWWorkObject
Determines whether any data field has changed.
getIsAltered() - Method in class filenet.vw.api.VWInstructionElement
Determines whether or not the fields have been modified.
getIsArray() - Method in class filenet.vw.api.VWParameterDefinition
Gets the state of the isArray flag for the parameter.
getIsCompleted() - Method in class filenet.vw.api.VWStepWorkObjectHistory
Determines whether or not process associated with the work item has been completed.
getIsConnectorQueue() - Method in class filenet.vw.api.VWQueueDefinition
Gets the isConnectorQueue flag, which indicates whether or not this queue is a connector.
getIsConnectorQueue() - Method in class filenet.vw.api.VWQueue
Determines whether or not this queue is a connector queue.
getIsLaunchStep() - Method in class filenet.vw.api.VWStepElement
Determines whether the current work item is a launch step.
getIsolatedRegion() - Method in class filenet.vw.api.VWSession
Gets an integer that specifies the isolated region for the current session.
getIsolatedRegion() - Method in class filenet.vw.api.VWWorkflowRuntimeId
Gets the isolated region.
getIsOverdue() - Method in class filenet.vw.api.VWParticipantHistory
Determines whether or not the step is overdue.
getIsReminded() - Method in class filenet.vw.api.VWParticipantHistory
Determines whether or not a reminder was sent to a participant.
getIsSameParticipant(VWParticipantHistory) - Method in class filenet.vw.api.VWParticipantHistory
Determines, by participant name, if the specified participant is the same as the current participant.
getIsSameParticipant(VWWorkObject) - Method in class filenet.vw.api.VWParticipantHistory
Determines, by work object number, if the specified work object is the same as the work object for the current participant.
getIsSystemField() - Method in class filenet.vw.api.VWDataField
Determines if the field is a system field.
getIsTracker() - Method in class filenet.vw.api.VWStepElement
Determines whether the current work item is a tracker work item.
getIsTracker() - Method in class filenet.vw.api.VWWorkObject
Determines whether this a tracker work object.
getIsWritable() - Method in class filenet.vw.api.VWDataField
Determines if the field is editable (writable).
getJoinType() - Method in class filenet.vw.api.VWMapNode
Gets the value of this step's JoinType property.
getKey() - Method in class filenet.vw.api.VWException
Retrieves the key to an exception.
getLastErrorNumber() - Method in class filenet.vw.api.VWWorkObject
Retrieves the last error number of the return stack frame for this work object.
getLastErrorText() - Method in class filenet.vw.api.VWWorkObject
Retrieves the last error text of the return stack frame for this work object.
getLastUpdateTime() - Method in class filenet.vw.api.VWInjectSessionInfo
Deprecated. Gets the time when the system last used the inject session.
getLaunchComments() - Method in class filenet.vw.api.VWWorkflowHistory
Gets comments included in the workflow when it was launched.
getLaunchDate() - Method in class filenet.vw.api.VWStepElement
Gets the date on which the workflow process associated with this step started.
getLaunchDate() - Method in class filenet.vw.api.VWWorkflowHistory
Gets the launch date of the workflow.
getLaunchDate() - Method in class filenet.vw.api.VWWorkObject
Retrieves the date on which the workflow process that contains this work object was launched.
getLaunchDate() - Method in class filenet.vw.api.VWRosterElement
Gets the launch date of the workflow process that contains the work object.
getLaunchResponse() - Method in class filenet.vw.api.VWWorkflowHistory
Gets the response included in the workflow when it was launched.
getLaunchStep() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the VWStepDefinition object of the launch step in this workflow definition.
getLength() - Method in class filenet.vw.api.VWExposedFieldDefinition
Gets the byte length of string data to be stored in the database search data field.
getLevel() - Method in class filenet.vw.api.VWValidationError
Gets the value of the level property of the current validation error.
getLevel() - Method in class filenet.vw.api.VWMilestoneDefinition
Gets the level of this milestone.
getLevel() - Method in class filenet.vw.api.VWMilestoneElement
Gets the level of the milestone.
getLibraryName() - Method in class filenet.vw.api.VWAttachment
Gets the name of the library or object store where the attachment resides.
getLibraryType() - Method in class filenet.vw.api.VWAttachment
Gets the library type of the library or object store that contains this attachment.
getLocalizedMessage() - Method in class filenet.vw.api.VWException
Retrieves the localized version of an exception message.
getLocalizedString(int) - Static method in class filenet.vw.api.VWQueueDefinition
Gets a localized string representation of the queue type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWOperationType
Gets a localized string representation of the operation type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWMergeType
Gets a localized string representation of the merge type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWModeType
Gets a localized string representation of the mode type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWAttachmentType
Gets a localized string associated with a valid attachment type integer value.
getLocalizedString(int) - Static method in class filenet.vw.api.VWFieldType
Retrieves the localized string containing the value of the field type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWLibraryType
Gets a localized string containing a description of the library or Object Store type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWLoggingOptionType
Gets a localized String representation of the logging option type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWTimeUnitType
Gets a localized String representation of the time unit type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWSystemConfiguration
Gets a localized String representation of the log type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWNodeType
Get a localized String representation of the node type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWJoinType
Gets a localized String representation of the join type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWFetchType
Gets the localized fetch type description.
getLocalizedString(int) - Static method in class filenet.vw.api.VWUserInfo
Gets a localized representation of the notification type.
getLocalizedString(int) - Static method in class filenet.vw.api.VWActionType
Gets a localized String representation of the action.
getLocalizedString(int) - Static method in class filenet.vw.api.VWSplitType
Gets a localized string representation of the split type.
getLocation() - Method in class filenet.vw.api.VWMapNode
Gets the value of the location property associated with this step.
getLocation() - Method in class filenet.vw.api.VWStepProcessorInfo
Deprecated. Replaced by getLocation(int).
getLocation() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Deprecated. Replaced by VWStepProcessorInfoDefinition.getLocation(int).
getLocation(int) - Method in class filenet.vw.api.VWStepProcessorInfo
Gets the location associated with this step processor information object, given the web application type identifier.
getLocation(int) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Gets the URL location associated with this step processor information object, for the given web application.
getLocations() - Method in class filenet.vw.api.VWStepProcessorInfo
Gets the locations associated with this step processor information object.
getLocations() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Gets the URL locations associated with this step processor, for each web application.
getLockedMachine() - Method in class filenet.vw.api.VWQueueElement
Gets the machine type of the system that locked the workflow object.
getLockedStatus() - Method in class filenet.vw.api.VWQueueElement
Determines the lock status for the workflow object.
getLockedUser() - Method in class filenet.vw.api.VWQueueElement
Gets the name of the user who has locked the workflow object.
getLockedUser() - Method in class filenet.vw.api.VWWorkObject
Retrieves the name of the user who locked the work object.
getLog() - Method in class filenet.vw.api.VWLogQuery
Gets the log retrieved by the VWLog.startQuery() method.
getLogDefinitions() - Method in class filenet.vw.api.VWSystemConfiguration
Gets the log definitions associated with this system configuration object.
getLogElement() - Method in class filenet.vw.api.VWMilestoneElement
Gets the VWLogElement object from which this VWMilestoneElement was originally constructed.
getLogFields() - Method in class filenet.vw.api.VWParticipantHistory
An array of VWDataField objects that represent exposed log fields.
getLoggingState() - Method in class filenet.vw.api.VWSystemConfiguration
Gets the value of all the logging states.
getLoggingState(int) - Method in class filenet.vw.api.VWSystemConfiguration
Determines whether or not a logging option is enabled or disabled.
getMachineId() - Method in class filenet.vw.api.VWLogElement
Retrieves the system type of the machine associated with the log element.
getMainAttachmentName() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the name of the main attachment of this workflow definition.
getMainMap() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the definition object that represents the main map in this workflow definition.
getMap(int) - Method in class filenet.vw.api.VWWorkflowDefinition
Deprecated. Replaced by VWWorkflowDefinition.getMap(String).

Note getMap(String) takes a map name as a parameter, rather than a Map ID.

getMap(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Retrieves a workflow map definition for the specified name.
getMapId() - Method in class filenet.vw.api.VWReturnStackElement
Gets the ID of the map for this stack object.
getMapId() - Method in class filenet.vw.api.VWMapDefinition
Retrieves the unique integer value of the workflow map ID, identifying a map within the containing workflow.
getMapName() - Method in class filenet.vw.api.VWValidationError
Gets the value in the map name property of this VWValidationError object.
getMapName() - Method in class filenet.vw.api.VWReturnStackElement
Gets the name of the map for this stack object.
getMapName() - Method in class filenet.vw.api.VWQueueElement
Gets the name of the map for the workflow object.
getMapName() - Method in class filenet.vw.api.VWLogElement
Gets the name of the workflow map of the work object (if an associated workflow map exists).
getMaps() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the set of workflow maps associated with this workflow definition.
getMaxDBOperations() - Method in class filenet.vw.api.VWSystemConfiguration
Gets the current maximum number of database operations per transaction.
getMaxInstructions() - Method in class filenet.vw.api.VWSystemConfiguration
Gets the current maximum number of instructions per transaction.
getMergeType() - Method in class filenet.vw.api.VWFieldDefinition
Gets the merge type property for the data field.
getMessage() - Method in class filenet.vw.api.VWValidationError
Retrieves the value in the message property of this validation error.
getMessage() - Method in class filenet.vw.api.VWMilestoneDefinition
Gets the message of this milestone.
getMessage() - Method in class filenet.vw.api.VWException
Retrieves the associated string from the exceptions resource file.
getMessage() - Method in class filenet.vw.api.VWMilestoneElement
Gets the message logged for this milestone event.
getMilestone(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the definition of a milestone from this workflow definition.
getMilestoneDefinitions() - Method in class filenet.vw.api.VWProcess
Gets the milestone data for this workflow process.
getMilestoneId() - Method in class filenet.vw.api.VWMilestoneElement
Gets the milestone ID of the milestone.
getMilestones() - Method in class filenet.vw.api.VWWorkflowDefinition
Retrieves the array of milestones for this workflow definition.
getMode() - Method in class filenet.vw.api.VWParameterDefinition
Gets the value of the mode property for the parameter.
getMode() - Method in class filenet.vw.api.VWParameter
Gets the integer value for the mode property of the parameter.
getMode() - Method in class filenet.vw.api.VWDataField
Returns the integer value associated with the mode of the data field.
getName() - Method in class filenet.vw.api.VWValidationError
Gets the name of the object that contains the error.
getName() - Method in class filenet.vw.api.VWQueueDefinition
Gets the name of the queue.
getName() - Method in class filenet.vw.api.VWIndexDefinition
Gets the index name associated with the index definition.
getName() - Method in class filenet.vw.api.VWMilestoneDefinition
Gets the name of this milestone.
getName() - Method in class filenet.vw.api.VWRouteDefinition
Gets the route name from the name property.
getName() - Method in class filenet.vw.api.VWExposedFieldDefinition
Gets the string containing the name of the exposed data field.
getName() - Method in class filenet.vw.api.VWMapNode
Gets the value of the current node's name property.
getName() - Method in class filenet.vw.api.VWMapDefinition
Gets the name of the Workflow Map.
getName() - Method in class filenet.vw.api.VWStepProcessorInfo
Gets the name associated with this step processor information object.
getName() - Method in class filenet.vw.api.VWParameterDefinition
Gets the parameter name.
getName() - Method in class filenet.vw.api.VWParameter
Gets the name of the parameter.
getName() - Method in class filenet.vw.api.VWLogDefinition
Gets the name of the log.
getName() - Method in interface filenet.vw.api.IVWTableDefinition
Provides the name of the queue.
getName() - Method in class filenet.vw.api.VWLog
Returns the name of the VWLog, as it is stored in the workflow database.
getName() - Method in class filenet.vw.api.VWDataField
Gets the long name of a field.
getName() - Method in class filenet.vw.api.VWUserInfo
Gets the name of the current user.
getName() - Method in class filenet.vw.api.VWFieldDefinition
Gets the String from the name property on the data field.
getName() - Method in class filenet.vw.api.VWMilestoneElement
Gets the milestone name of the milestone definition for this milestone event.
getName() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Gets the name associated with this step processor's information object.
getName() - Method in class filenet.vw.api.VWOperationDefinition
Returns the name of this operation.
getName() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the value of the name property for this workflow definition object.
getName() - Method in class filenet.vw.api.VWRosterDefinition
Gets the name of the roster.
getNameSpace() - Static method in class filenet.vw.api.VWXMLUtil
Gets the namespace string used by this class.
getNextRoutes() - Method in class filenet.vw.api.VWMapNode
Gets the definition of each outbound route associated with the current node.
getNodeType() - Method in class filenet.vw.api.VWMapNode
Returns the value of the map node type.
getNotificationFlags() - Method in class filenet.vw.api.VWUserInfo
Gets the number that represents the combined notification flag settings for the user.
getNumberOfActiveChildWO() - Method in class filenet.vw.api.VWRosterStats
Determines how many active child work objects existed at the sample point.
getNumberOfActiveParentWO() - Method in class filenet.vw.api.VWRosterStats
Determines how many active parent work objects existed at the sample point.
getNumberOfCreatedChildWO() - Method in class filenet.vw.api.VWRosterStats
Determines how many child work objects the application created within the time interval.
getNumberOfCreatedParentWO() - Method in class filenet.vw.api.VWRosterStats
Determines how many parent work objects the application created within the time interval.
getNumberOfInitialChildWO() - Method in class filenet.vw.api.VWRosterStats
Gets the initial number of child work objects at the beginning of the time interval.
getNumberOfInitialParentWO() - Method in class filenet.vw.api.VWRosterStats
Gets the number of parent work objects at the beginning of the time interval.
getNumberOfRemainingChildWO() - Method in class filenet.vw.api.VWRosterStats
Gets the number of child work objects that are still active at the end of the time interval.
getNumberOfRemainingParentWO() - Method in class filenet.vw.api.VWRosterStats
Gets the number of parent work objects that are alive at the end of the time interval.
getNumberOfRemainingQueued() - Method in class filenet.vw.api.VWQueueStats
Gets the final number of work objects in the queue.
getNumberOfSamples() - Method in class filenet.vw.api.VWRosterStats
Gets a number that indicates the number of samples taken within the interval.
getNumberOfSamples() - Method in class filenet.vw.api.VWQueueStats
Gets a number that indicates the number of samples taken within the evaluation period.
getNumberOfTerminatedChildWO() - Method in class filenet.vw.api.VWRosterStats
Determines how many child work objects the application terminated since the beginning of the time interval.
getNumberOfTerminatedParentWO() - Method in class filenet.vw.api.VWRosterStats
Determines how many parent work objects the application terminated since the beginning of the time interval.
getNumberOfUnitsInPeriod() - Method in class filenet.vw.api.VWRosterStats
Gets a count that indicates the number of units in the given time interval.
getNumberOfUnitsInPeriod() - Method in class filenet.vw.api.VWQueueStats
Gets a count that indicates the number of time units in the evaluation period.
getNumberOfWOLocked() - Method in class filenet.vw.api.VWQueueStats
Gets the number of work objects locked during the evaluation period.
getNumberOfWOProcessed() - Method in class filenet.vw.api.VWQueueStats
Gets the number of work objects processed during the evaluation period.
getOccurrenceId() - Method in class filenet.vw.api.VWStepOccurrenceHistory
Gets the occurrence id.
getOperation(String) - Method in class filenet.vw.api.VWQueueDefinition
Gets the definition of an operation from this queue definition.
getOperationName() - Method in class filenet.vw.api.VWStepElement
Gets the name of the current operation on the work item.
getOperationName() - Method in class filenet.vw.api.VWQueueElement
Gets the current Operation name of the workflow object.
getOperationName() - Method in class filenet.vw.api.VWWorkObject
Retrieves the name of the current operation on the work object.
getOperationName() - Method in class filenet.vw.api.VWLogElement
Gets the Operation name of the log element (if an associated Operation exists).
getOperationName() - Method in class filenet.vw.api.VWStepDefinition
Gets the name of the operation associated with this step.
getOperationName() - Method in class filenet.vw.api.VWInstructionElement
Gets the name of the current Operation.
getOperationParameters() - Method in class filenet.vw.api.VWStepDefinition
Gets the array of Strings containing the parameter expressions for the operation associated with this step.
getOperations() - Method in class filenet.vw.api.VWQueueDefinition
Lists the operation definitions for the queue definition.
getOperationType() - Method in class filenet.vw.api.VWWorkObject
Retrieves the operation type of the current work order.
getOriginator() - Method in class filenet.vw.api.VWStepElement
Gets the name of the user who initiated the workflow process containing this step.
getOriginator() - Method in class filenet.vw.api.VWWorkflowHistory
Gets the name of the workflow originator.
getOriginator() - Method in class filenet.vw.api.VWWorkObject
Retrieves the name of the user who initiated the workflow process that contains this work object.
getOriginator() - Method in class filenet.vw.api.VWRosterElement
Gets the name of the user who initiated the workflow process that contains this work object.
getOverdue() - Method in class filenet.vw.api.VWParticipantHistory
Gets the overdue date/time information.
getOverdue() - Method in class filenet.vw.api.VWStepElement
Gets status of the overdue notice.
getOverdue() - Method in class filenet.vw.api.VWWorkObject
Retrieves the status of the overdue notice.
getParameterDataFields() - Method in class filenet.vw.api.VWInstructionElement
Gets the data fields for the Instruction Element, which excludes participant lists and attachments.
getParameterDefinition(String) - Method in class filenet.vw.api.VWStepDefinition
Gets a parameter definition from the set of parameter definitions stored in this step definition.
getParameterDefinition(String) - Method in class filenet.vw.api.VWOperationDefinition
Gets a parameter definition from the set of parameter definitions stored in this operation definition.
getParameterDefinitions() - Method in class filenet.vw.api.VWStepDefinition
Gets the parameter definitions stored in the current step definition.
getParameterDefinitions() - Method in class filenet.vw.api.VWOperationDefinition
Gets the parameters of this operation.
getParameterNames() - Method in class filenet.vw.api.VWStepElement
Lists system and user step element parameter names.
getParameters(int, int) - Method in class filenet.vw.api.VWStepElement
Gets the system or user (or both) parameters in this step, given their specific types.
getParameterValue(String) - Method in class filenet.vw.api.VWStepElement
Gets the value of a specified parameter.
getParams() - Method in class filenet.vw.api.VWSimpleInstruction
Gets the parameters of this instruction.
getParams() - Method in class filenet.vw.api.VWRollbackInstruction
Gets the parameters of this instruction.
getParentCreationRate() - Method in class filenet.vw.api.VWRosterStats
Gets the rate at which the application created parent work objects in the time interval, based on the time units entered.
getParentGrowRate() - Method in class filenet.vw.api.VWRosterStats
Gets the rate at which parent work objects grew in the system; the grow rate is the relationship defined as the ratio of the creation rate to the termination rate.
getParentTerminationRate() - Method in class filenet.vw.api.VWRosterStats
Gets the rate at which the application terminated parent work objects in the time interval, based on the time units entered.
getParentWorkObjectNumber() - Method in class filenet.vw.api.VWLogElement
Gets the string version of the Parent work object number.
getParticipantName() - Method in class filenet.vw.api.VWParticipantHistory
Gets the name of the participant.
getParticipantName() - Method in class filenet.vw.api.VWStepElement
Gets the name of the participant who is processing the current step.
getParticipantName() - Method in class filenet.vw.api.VWWorkObject
Retrieves the name of the participant who is processing this work object.
getParticipantName() - Method in class filenet.vw.api.VWParticipant
Gets the name of the participant associated with the VWParticipant object.
getParticipants() - Method in class filenet.vw.api.VWStepDefinition
Gets the participants property value for the step.
getPostAssignments() - Method in class filenet.vw.api.VWStepDefinition
Gets the postAssignments property value for the step, which defines field values to be set after the step processes.
getPostMilestone() - Method in class filenet.vw.api.VWStepDefinition
Gets the value of this step's post-milestone property, which is the name of a milestone in this workflow which is "reached" just after this step finishes execution.
getPreAssignments() - Method in class filenet.vw.api.VWStepDefinition
Gets the preAssignments property value for the step, which defines field values to be set before the step processes.
getPreMilestone() - Method in class filenet.vw.api.VWStepDefinition
Gets the value of this step's pre-milestone property, which is the name of a milestone in this workflow which is "reached" just after this step executes.
getPreviousRoutes() - Method in class filenet.vw.api.VWMapNode
Gets the definition of each inbound route associated with this step.
getProcess() - Method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.fetchProcess()
getProcess() - Method in class filenet.vw.api.VWRosterElement
Deprecated. Replaced by VWStepElement.fetchProcess() or VWWorkObject.fetchProcess(), depending on the type of process
getProcessorType() - Method in class filenet.vw.api.VWStepProcessorInfo
Gets the processor type, step or launch, default or not.
getProcessorType() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Gets the processor type.
getProxyUserName() - Method in class filenet.vw.api.VWUserInfo
Gets the proxy user name.
getQueue() - Method in class filenet.vw.api.VWQueueQuery
Gets the queue retrieved by the VWQueue.createQuery() method or the deprecated VWQueue.startQuery() method.
getQueue(String) - Method in class filenet.vw.api.VWSession
Gets a queue object for the specified queue.
getQueueDefinitions() - Method in class filenet.vw.api.VWSystemConfiguration
Lists all queue definitions for the current configuration.
getQueuedRate() - Method in class filenet.vw.api.VWQueueStats
Gets the ratio of the number of work objects queued to the number of time units in the evaluation period.
getQueueGrowthRate() - Method in class filenet.vw.api.VWQueueStats
Gets the ratio of the queued work objects to the dequeued work objects over the evaluation period.
getQueueName() - Method in class filenet.vw.api.VWParticipantHistory
Gets the name of the queue.
getQueueName() - Method in class filenet.vw.api.VWStepElement
Gets the name of the queue this step element associated with the current operation.
getQueueName() - Method in class filenet.vw.api.VWQueueElement
Gets the name of the queue in which the workflow object currently resides.
getQueueName() - Method in class filenet.vw.api.VWLogElement
Gets the name of the queue, containing the log element, that contains the work object (if an associated queue name exists).
getQueueName() - Method in class filenet.vw.api.VWStepDefinition
Gets the name of the queue associated with this step.
getQueueName() - Method in class filenet.vw.api.VWQueueStats
Gets the name of the queue for the statistics object.
getQueueNames(boolean) - Method in class filenet.vw.api.VWSession
Deprecated. Replaced by VWSession.fetchQueueNames(int)
getQueueType() - Method in class filenet.vw.api.VWQueueDefinition
Gets the queue type of this queue definition.
getQueueType() - Method in class filenet.vw.api.VWQueue
Gets an integer value indicating the queue type.
getReadSecurity() - Method in class filenet.vw.api.VWQueueDefinition
Lists the user and/or groups who have Read access to the queue.
getReadSecurity() - Method in class filenet.vw.api.VWRosterDefinition
Lists the users and/or groups who currently have Read-only access to the roster.
getReDo() - Method in class filenet.vw.api.VWRollbackInstruction
Gets this instruction's re-do expression.
getRelease() - Method in class filenet.vw.api.VWRouteDefinition
Gets the value in the release flag.
getReminder() - Method in class filenet.vw.api.VWParticipantHistory
Gets the reminder date/time information.
getReminder() - Method in class filenet.vw.api.VWStepElement
Gets the date on which the application issues a reminder for this step.
getReminder() - Method in class filenet.vw.api.VWWorkObject
Retrieves the date on which a reminder is to be issued for the step.
getReminder() - Method in class filenet.vw.api.VWStepDefinition
Gets the value of this step's reminder property.
getReminder() - Method in class filenet.vw.api.VWWorkflowDefinition
Retrieves the value of the reminder property for this workflow definition.
getRequestedEndTime() - Method in class filenet.vw.api.VWRosterStats
Gets the time value the user specified as the end time for the queue statistics evaluation.
getRequestedEndTime() - Method in class filenet.vw.api.VWQueueStats
Gets the time value the user specified as the end time for the queue statistics evaluation.
getRequestedInterface() - Method in class filenet.vw.api.VWStepDefinition
Gets the requested interface of the step (usually a step processor name associated with the top level UI).
getRequestedStartTime() - Method in class filenet.vw.api.VWRosterStats
Gets the time value the user specified as the start time for the queue statistics evaluation.
getRequestedStartTime() - Method in class filenet.vw.api.VWQueueStats
Gets the time value the user specified as the start time for the queue statistics evaluation.
getRequestedTimeUnit() - Method in class filenet.vw.api.VWRosterStats
Gets evaluation period unit of measure (or interval) specified by the user (for example: minutes, hours, days, etc.).
getRequestedTimeUnit() - Method in class filenet.vw.api.VWQueueStats
Gets the evaluation period unit of measure (or interval) specified by the user (for example, minutes, hours, days, etc.).
getResponse() - Method in class filenet.vw.api.VWParticipantHistory
Gets the participant's response to the step.
getResponses() - Method in class filenet.vw.api.VWStepDefinition
Gets the responses to this step.
getRoster() - Method in class filenet.vw.api.VWRosterQuery
Gets a roster that was retrieved by the query initiated by either the VWRoster.createQuery() or VWRoster#startQuery(String, Object[], Object[], int, String, Object[]) methods.
getRoster(String) - Method in class filenet.vw.api.VWSession
Gets a VWRoster object that represents the specified workflow roster. A workflow roster is a collection of records that represents the work objects that an associated work class instantiates.
getRosterDefinitions() - Method in class filenet.vw.api.VWSystemConfiguration
Gets the roster definitions associated with this system configuration.
getRosterName() - Method in class filenet.vw.api.VWCreateLiveWOResult
Retrieves a string representation of roster name returned by the createLiveWorkObject.
getRosterName() - Method in class filenet.vw.api.VWStepElement
Gets the name of the roster associated with the work item.
getRosterName() - Method in class filenet.vw.api.VWProcess
Gets the roster name of this workflow process.
getRosterName() - Method in class filenet.vw.api.VWWorkObject
Retrieves the name of the roster for this work object.
getRosterName() - Method in class filenet.vw.api.VWRosterElement
Returns the name of the roster.
getRosterName() - Method in class filenet.vw.api.VWRosterStats
Gets the name of the roster for the statistics being retrieved.
getRosterName() - Method in class filenet.vw.api.VWWorkflowSignature
Returns the roster name.
getRosterName() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets this workflow definition's roster work class name, that applies to the transfer or initialization of rosters.
getRosterNames() - Method in class filenet.vw.api.VWSession
Deprecated. Replaced by VWSession.fetchQueueNames(int)
getRoute(int) - Method in class filenet.vw.api.VWMapNode
Gets the route definition object specified by the route ID parameter.
getRouteFrom(int) - Method in class filenet.vw.api.VWMapNode
Gets the inbound route from another step.
getRouteId() - Method in class filenet.vw.api.VWRouteDefinition
Gets the value of the routeId property.
getRouterURL() - Method in class filenet.vw.api.VWSession
Gets the service name in String format, as follows: <:host name>:<port>/<router name>
getRouteTo(int) - Method in class filenet.vw.api.VWMapNode
Gets the outbound route to another step.
getRuleSets() - Method in class filenet.vw.api.VWWorkflowDefinition
Retrieves the array of VWRuleSetDefinition objects for this workflow definition.
getRuleSets(int) - Method in class filenet.vw.api.VWMapNode
Retrieves the array of VWRuleSetDefinition objects for this step definition of the type, specified by the ruleSetSelector parameter.
getRuntimeId() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the runtime ID for the workflow definition.
getSecurityDatabaseType() - Method in class filenet.vw.api.VWSession
Returns the type of security database.
getSelectedResponse() - Method in class filenet.vw.api.VWStepElement
Gets the response selected by the user for the current step.
getSelectedResponse() - Method in class filenet.vw.api.VWWorkObject
Retrieves your response to this work object.
getSequenceNumber() - Method in class filenet.vw.api.VWLogElement
Gets the simple sequence number of the record, beginning the count at 1 and increasing by one with each new record.
getServerAssignment() - Method in class filenet.vw.api.VWUserInfo
Gets the server ID associated with the user.
getServerId() - Method in class filenet.vw.api.VWQueueDefinition
Gets the server ID of this queue definition.
getServerId() - Method in class filenet.vw.api.VWRosterDefinition
Gets the home server ID of this roster definition.
getServerIDs() - Method in class filenet.vw.api.VWSystemConfiguration
Lists the all available server IDs.
getServerLocation() - Method in class filenet.vw.api.VWRosterElement
Gets the current server location of the work object.
getServerName() - Method in class filenet.vw.api.VWSession
Returns the name of the Process Engine's server for the current session.
getServiceName() - Method in class filenet.vw.api.VWWorkflowRuntimeId
Returns the service name.
getServiceSession() - Method in class filenet.vw.api.VWRoster
Identifies the session that originated the search object.
getServiceSession() - Method in class filenet.vw.api.VWQueue
Identifies the session that instantiated the search object.
getServiceSession() - Method in class filenet.vw.api.VWLog
Gets the session that contains the query object.
getSessionName() - Method in class filenet.vw.api.VWInjectSessionInfo
Deprecated. Gets the session name.
getSessionStatus() - Method in class filenet.vw.api.VWInjectSessionInfo
Deprecated. Get session status.
getSessionTimeOut() - Method in class filenet.vw.api.VWSystemAdministration
Gets the number minutes before a client / server session timeout.
getSourceName() - Method in class filenet.vw.api.VWExposedFieldDefinition
Gets the string containing the source name of the exposed data field.
getSourceStep() - Method in class filenet.vw.api.VWRouteDefinition
Gets an object containing the source node.
getSourceStepId() - Method in class filenet.vw.api.VWRouteDefinition
Gets the integer value of the stepId property for the step source.
getSplitType() - Method in class filenet.vw.api.VWMapNode
Gets the step's split type.
getStartStep() - Method in class filenet.vw.api.VWMapDefinition
Gets the start step definition for the current map.
getStartTime() - Method in class filenet.vw.api.VWRosterStats
Gets the time the evaluated request began on the server.
getStartTime() - Method in class filenet.vw.api.VWQueueStats
Gets the time the evaluated request began on the server.
getStatisticsCollection() - Method in class filenet.vw.api.VWSystemConfiguration
Gets the current state of the statistics collection option.
getStatisticsConsolidationInterval() - Method in class filenet.vw.api.VWSystemAdministration
Gets the number minutes used for domain-wide statistics that are written the database.
getStatisticsSnapshotInterval() - Method in class filenet.vw.api.VWSystemAdministration
Deprecated. Not replaced
getStep(int) - Method in class filenet.vw.api.VWMapDefinition
Uses the integer value of a step ID on the current workflow map to get the associated step definition.
getStepDeadlineStatus() - Method in class filenet.vw.api.VWQueueElement
Gets the deadline status for the current step.
getStepDescription() - Method in class filenet.vw.api.VWStepElement
Gets the description of a step.
getStepId() - Method in class filenet.vw.api.VWValidationError
Gets an integer value that is the step ID property of the current validation error.
getStepId() - Method in class filenet.vw.api.VWStepHistory
Retrieves the value of the step Id.
getStepId() - Method in class filenet.vw.api.VWReturnStackElement
Gets the ID of the step for this stack object.
getStepId() - Method in class filenet.vw.api.VWMapNode
Gets the value of this step's stepId property.
getStepId() - Method in class filenet.vw.api.VWStepWorkObjectHistory
Retrieves the Id number for the step processor.
getStepId() - Method in class filenet.vw.api.VWMilestoneElement
Gets the step ID of the step where the milestone event occurred.
getStepName() - Method in class filenet.vw.api.VWStepHistory
Retrieves the step name.
getStepName() - Method in class filenet.vw.api.VWStepElement
Gets the String step name.
getStepName() - Method in class filenet.vw.api.VWReturnStackElement
Gets the name of the step for this stack object.
getStepName() - Method in class filenet.vw.api.VWQueueElement
Gets the step label for the queue element.
getStepName() - Method in class filenet.vw.api.VWLogElement
Gets the step name for the log element (if an associated step name exists).
getStepProcessorInfoDefinitions() - Method in class filenet.vw.api.VWSystemConfiguration
Gets the VWStepProcessorInfoDefinition objects associated with this System Configuration object.
getStepResponses() - Method in class filenet.vw.api.VWStepElement
Gets a list of available responses for the current step.
getStepResponses() - Method in class filenet.vw.api.VWWorkObject
Retrieves the list of available responses in this work object.
getSteps() - Method in class filenet.vw.api.VWMapDefinition
Gets the steps contained in the VWMapDefinition.
getStepStatus() - Method in class filenet.vw.api.VWParticipantHistory
Gets an integer associated with the activity status for the participant working on the step.
getStepStatus() - Method in class filenet.vw.api.VWStepOccurrenceHistory
Gets the step status of this step occurrence
getStringFromKey(String) - Static method in class filenet.vw.api.VWException
Retrieves the string in the exceptions resource file that corresponds to the exception key.
getStringValue() - Method in class filenet.vw.api.VWParameter
Converts the value of this parameter to a string.
getStringValue() - Method in interface filenet.vw.api.IVWField
Get the value from the field in String format.
getStringValue() - Method in class filenet.vw.api.VWDataField
Gets the data field value as a String.
getStringValue() - Method in class filenet.vw.api.VWFieldDefinition
Gets the initial value of the field type definition in String format, converted from any valid field type.
getSubject() - Method in class filenet.vw.api.VWStepElement
Gets the subject of the workflow associated with the current step.
getSubject() - Method in class filenet.vw.api.VWWorkObject
Retrieves the subject of the workflow associated with this step.
getSubject() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the value in the subject property of this workflow definition.
getSubStepId() - Method in class filenet.vw.api.VWValidationError
Gets an integer value that is the ID property of the object that caused the current validation error, within the current step.
getSummationActiveChild() - Method in class filenet.vw.api.VWRosterStats
Determines how many child work objects are alive in the system.
getSummationActiveParent() - Method in class filenet.vw.api.VWRosterStats
Determines how many parent work objects are alive in the system.
getSummationActiveWO() - Method in class filenet.vw.api.VWRosterStats
Determines how many work objects are alive in the system.
getSummationChildLifeSpan() - Method in class filenet.vw.api.VWRosterStats
Gets the life span of the child work objects.
getSummationDurationWOInQueue() - Method in class filenet.vw.api.VWQueueStats
Gets the summation of the durations of work objects in the queue, summed over the samples in the evaluation period.
getSummationParentLifeSpan() - Method in class filenet.vw.api.VWRosterStats
Gets the life span of the parent work objects.
getSummationQueueDepth() - Method in class filenet.vw.api.VWQueueStats
Gets a number representing the sum of all queue depths for the samples in the evaluation period.
getSummationWOLifeSpan() - Method in class filenet.vw.api.VWRosterStats
Gets the life span of the work objects.
getSummationWOLocked() - Method in class filenet.vw.api.VWQueueStats
Gets a number representing the summation of the counts of all work objects locked in the queue for each sample, summed over the samples in the evaluation period.
getSummationWOProcessed() - Method in class filenet.vw.api.VWQueueStats
Gets a number representing the sum of the counts of all work objects that have been advanced or updated for the samples in the evaluation period.
getSystemDefinedFieldNames() - Method in class filenet.vw.api.VWQueueElement
Lists names of the Process Engine fields supported by this queue element.
getSystemWideFlags() - Method in class filenet.vw.api.VWSystemAdministration
Gets an integer that represents the combined system-wide configuration flags.
getTag() - Method in class filenet.vw.api.VWStepElement
Gets the work item tag.
getTag() - Method in class filenet.vw.api.VWQueueElement
Gets the tag of the workflow object.
getTag() - Method in class filenet.vw.api.VWWorkObject
Retrieves a string version of the work object tag.
getTag() - Method in class filenet.vw.api.VWRosterElement
Gets the tag of the work object (as a string).
getTag() - Method in class filenet.vw.api.VWInstructionElement
Gets the workflow object tag, as the workflow system stores it in the database.
getTag() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the value in the tag expression of this workflow definition.
getText() - Method in class filenet.vw.api.VWLogElement
Gets the string of text entered in the log.
getTimeOut() - Method in class filenet.vw.api.VWWFEInstruction
Get the value of this instruction's timeOut expression property.
getTimestamp() - Method in class filenet.vw.api.VWMilestoneElement
Gets the timestamp of the milestone event, according to the time at which the milestone event was logged.
getTimeStamp() - Method in class filenet.vw.api.VWLogElement
Gets the timestamp of the current log record.
getToken() - Method in class filenet.vw.api.VWSession
Gets a token from the user logon, which a shared logon may use.
getTotalAbortedTime() - Method in class filenet.vw.api.VWQueueStats
Gets a double-precision number indicating the total queue time (in the requested work units) taken by work objects that were unlocked and never processed.
getTotalCreationRate() - Method in class filenet.vw.api.VWRosterStats
Gets the rate at which the application created work objects in the time interval, based on the time units entered.
getTotalGrowRate() - Method in class filenet.vw.api.VWRosterStats
Gets the rate at which work objects grew in the system; the grow rate is the relationship defined as the ratio of the creation rate to the termination rate.
getTotalNumberOfActiveWO() - Method in class filenet.vw.api.VWRosterStats
Determines how many active work objects existed at the sample point.
getTotalNumberOfCreatedWO() - Method in class filenet.vw.api.VWRosterStats
Determines how many work objects the application created within the time interval.
getTotalNumberOfRemainingWO() - Method in class filenet.vw.api.VWRosterStats
Gets the number of work objects that are alive at the end of the time interval.
getTotalNumberOfTerminatedWO() - Method in class filenet.vw.api.VWRosterStats
Determines how many work objects the application terminated since the beginning of the time interval.
getTotalServiceTime() - Method in class filenet.vw.api.VWQueueStats
Gets a double-precision number indicating the total queue time (in the requested work units) taken by locked work objects until they are advanced or updated.
getTotalTerminationRate() - Method in class filenet.vw.api.VWRosterStats
Gets the rate at which the application terminated work objects in the time interval, based on the time units entered.
getTotalWOAborted() - Method in class filenet.vw.api.VWQueueStats
Gets a number indicating the total number of the work objects that are locked and then unlocked without processing since the beginning of the time interval.
getTotalWODequeued() - Method in class filenet.vw.api.VWQueueStats
Gets a number that indicates the count of all of the work objects dequeued since the beginning of the time interval.
getTotalWOQueued() - Method in class filenet.vw.api.VWQueueStats
Gets a double-precision number that is the count of all work objects queued during the evaluation period.
getTrackers() - Method in class filenet.vw.api.VWWorkObject
Retrieves the list of trackers associated with this work object.
getTransferDateTime() - Method in class filenet.vw.api.VWWorkflowSignature
Returns a date that holds the transfer date/time.
getTransferUserId() - Method in class filenet.vw.api.VWWorkflowSignature
Returns an integer that is the transfer user Id.
getTransferUserName() - Method in class filenet.vw.api.VWWorkflowSignature
Returns the transfer user name.
getTuple() - Method in class filenet.vw.api.VWServerException
Retrieves the hex tuple from the exception associated with the server tuple.
getType() - Method in class filenet.vw.api.VWAttachment
Gets the attachment type value for the associated attachement.
getUserDefinedFieldNames() - Method in class filenet.vw.api.VWQueueElement
Lists the names of the user-defined fields supported by the queue element.
getUserName() - Method in class filenet.vw.api.VWParticipantHistory
Gets the name of the participant who completed, reassigned or delegated the work.
getUserName() - Method in class filenet.vw.api.VWLogElement
Gets the user name associated with the log record.
getUserNames() - Method in class filenet.vw.api.VWSession
Deprecated. Replaced by VWSession.fetchUsers(int, boolean)
getValue() - Method in class filenet.vw.api.VWRuleSetDefinition
Gets the value of this rule set.
getValue() - Method in class filenet.vw.api.VWParameterDefinition
Gets the value stored in the value property.
getValue() - Method in class filenet.vw.api.VWParameter
Gets the value of the parameter.
getValue() - Method in class filenet.vw.api.VWEventDefinition
Gets this event's value expression.
getValue() - Method in interface filenet.vw.api.IVWField
Get the value from the field as a java Object.
getValue() - Method in class filenet.vw.api.VWDataField
Gets the value of a field as a valid field type object.
getValue() - Method in class filenet.vw.api.VWFieldDefinition
Gets the value of the field in the format of any valid field type, as a Java Object.
getVersion() - Method in class filenet.vw.api.VWAttachment
Gets the version of this attachment.
getVersion() - Method in class filenet.vw.api.VWTransferResult
Retrieves a string representation of the version returned by the transfer.
getVWFieldType(Object) - Static method in class filenet.vw.api.VWFieldType
Gets the field type of the passed object.
getWidth() - Method in class filenet.vw.api.VWStepProcessorInfo
Gets the width, in pixels, specified for the step processor.
getWidth() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Gets the width of the step processor, specified in pixels.
getWorkClassId() - Method in class filenet.vw.api.VWStepElement
Gets the ID of the work class for this work item.
getWorkClassId() - Method in class filenet.vw.api.VWWorkflowRuntimeId
Returns the work class id.
getWorkClassName() - Method in class filenet.vw.api.VWStepElement
Gets the name of the work class from which the application instantiates the work item.
getWorkClassName() - Method in class filenet.vw.api.VWWorkflowHistory
Returns the work class name of the workflow.
getWorkClassName() - Method in class filenet.vw.api.VWProcess
Gets the work class name associated with this workflow process.
getWorkClassName() - Method in class filenet.vw.api.VWQueueElement
Gets the name of the work class from which the workflow object is instantiated.
getWorkClassName() - Method in class filenet.vw.api.VWWorkObject
Retrieves the name of the work class from which the application instantiates this work object.
getWorkClassName() - Method in class filenet.vw.api.VWEventDefinition
Gets the value of this event's work class name property.
getWorkClassName() - Method in class filenet.vw.api.VWLogElement
Gets the name of the work class from which the work object is instantiated, if there is an associated work class name.
getWorkClassName() - Method in class filenet.vw.api.VWInstructionElement
Gets the name of the work class which can be used to instantiate the workflow object.
getWorkflowName() - Method in class filenet.vw.api.VWStepElement
Gets the name of the workflow associated with the current step.
getWorkflowName() - Method in class filenet.vw.api.VWQueueElement
Gets the name of the work class from which the workflow object logged was instantiated.
getWorkflowName() - Method in class filenet.vw.api.VWWorkObject
Retrieves the name of the workflow associated with this step.
getWorkflowName() - Method in class filenet.vw.api.VWLogElement
Gets the name of the workflow (if an associated workflow name exists).
getWorkflowNumber() - Method in class filenet.vw.api.VWStepElement
Gets the string version of the workflow number.
getWorkflowNumber() - Method in class filenet.vw.api.VWWorkObject
Retrieves the string version of the workflow number.
getWorkflowNumber() - Method in class filenet.vw.api.VWRosterElement
Gets the string version of the workflow number.
getWorkFlowNumber() - Method in class filenet.vw.api.VWStepElement
Deprecated. Replaced by VWStepElement.getWorkflowNumber()
getWorkFlowNumber() - Method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.getWorkflowNumber()
getWorkFlowNumber() - Method in class filenet.vw.api.VWRosterElement
Deprecated. Replaced by VWRosterElement.getWorkflowNumber()
getWorkObjectName() - Method in class filenet.vw.api.VWStepElement
Gets the work item name.
getWorkObjectName() - Method in class filenet.vw.api.VWQueueElement
Gets the workflow object name.
getWorkObjectName() - Method in class filenet.vw.api.VWWorkObject
Retrieves the work object name.
getWorkObjectName() - Method in class filenet.vw.api.VWRosterElement
Gets the work object name.
getWorkObjectName() - Method in class filenet.vw.api.VWInstructionElement
Gets the workflow object name.
getWorkObjectNumber() - Method in class filenet.vw.api.VWCreateLiveWOResult
Retrieves a string representation of F_WobNum returned by the VWSession.createLiveWorkObject() method.
getWorkObjectNumber() - Method in class filenet.vw.api.VWParticipantHistory
Gets the work object number for the activity history for the participant.
getWorkObjectNumber() - Method in class filenet.vw.api.VWStepElement
Gets the work item number, in string format.
getWorkObjectNumber() - Method in class filenet.vw.api.VWQueueElement
Gets the workflow object.
getWorkObjectNumber() - Method in class filenet.vw.api.VWWorkObject
Retrieves a string version of the work object number.
getWorkObjectNumber() - Method in class filenet.vw.api.VWRosterElement
Gets the work object number (as a string).
getWorkObjectNumber() - Method in class filenet.vw.api.VWLogElement
Gets the string version of the work object number.
getWorkObjectNumber() - Method in class filenet.vw.api.VWInstructionElement
Gets the string version of the F_WobNum(workflow object number).
getWorkObjectNumber() - Method in class filenet.vw.api.VWStepWorkObjectHistory
Retrieves a string representation of the work object number.
getWorkObjectTag() - Method in class filenet.vw.api.VWLogElement
Gets the work object tag value.
getWorkOrderId() - Method in class filenet.vw.api.VWWorkObject
Retrieves the work order ID associated with this work object.
getWorkOrderId() - Method in class filenet.vw.api.VWLogElement
Gets the authored work order ID for the Instruction or step the work object was processing at the time the system logged the record.
getWorkPerformerClassName() - Method in class filenet.vw.api.VWQueueElement
Deprecated. Replaced by VWQueueElement.getQueueName()
getWorkPerformerClassName() - Method in class filenet.vw.api.VWWorkObject
Retrieves the name of the Work Performer Class associated with the queue on which the work object resides.
getWorkPerformerClassName() - Method in class filenet.vw.api.VWInstructionElement
Gets the name of the Work Performer Class associated with the queue on which the workflow object currently resides.
getWorkSpaceId() - Method in class filenet.vw.api.VWStepElement
Gets the ID of the work space for this work item.
getWriteSecurity() - Method in class filenet.vw.api.VWQueueDefinition
Lists the user and/or groups who have Write access to the queue.
getWriteSecurity() - Method in class filenet.vw.api.VWRosterDefinition
Lists users and/or groups who have Write access to the roster.

H

hasBeenAltered(String) - Method in class filenet.vw.api.VWWorkObject
Determines whether a specific field has changed.
hasBeenAltered(String) - Method in class filenet.vw.api.VWInstructionElement
Determines whether or not the field has been modified.
hasChanged() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Determines whether or not this step processor definition has changed.
hasField(String) - Method in class filenet.vw.api.VWLogElement
Determines whether or not the user-defined field name exists.
hasFieldName(String) - Method in class filenet.vw.api.VWQueueDefinition
Determines whether or not the specified queue exposed field exists.
hasFieldName(String) - Method in class filenet.vw.api.VWQueueElement
Determines whether the specified field exists.
hasFieldName(String) - Method in class filenet.vw.api.VWWorkObject
Determines whether the specified data field exists.
hasFieldName(String) - Method in class filenet.vw.api.VWRosterElement
Determines whether the specified field exists.
hasFieldName(String) - Method in class filenet.vw.api.VWInstructionElement
Determines whether or not the specified field exists.
hasFieldName(String) - Method in class filenet.vw.api.VWNewWorkObject
Deprecated. Indicates whether or not the specified data field exists.
hasNext() - Method in class filenet.vw.api.VWStepHistory
Indicates whether another element can be fetched from this VWStepHistory instance.
hasNext() - Method in class filenet.vw.api.VWRosterQuery
Indicates whether another element can be fetched from this VWRosterQuery instance.
hasNext() - Method in class filenet.vw.api.VWWorkflowHistory
Indicates whether another element can be fetched from this VWWorkflowHistory instance.
hasNext() - Method in class filenet.vw.api.VWQueueQuery
Indicates whether another element can be fetched from this VWQueueQuery instance.
hasNext() - Method in class filenet.vw.api.VWProcess
Determines whether there are more work objects to retrieve.
hasNext() - Method in class filenet.vw.api.VWLogQuery
Determines whether or not more elements exist beyond the current element.
hasNext() - Method in class filenet.vw.api.VWWorkflowMilestones
Returns true if the current VWWorkflowMilestones instance has more VWMilestoneElement object elements.
hasNext() - Method in class filenet.vw.api.VWStepWorkObjectHistory
Indicates whether another element can be fetched from this VWStepWorkObjectHistory instance.
hasNext() - Method in class filenet.vw.api.VWSecurityList
Indicates whether another element can be fetched from this VWSecurityList instance.
hasNext() - Method in class filenet.vw.api.VWStepOccurrenceHistory
Indicates whether another element can be fetched from this VWStepOccurrenceHistory instance.
hasParameterName(String) - Method in class filenet.vw.api.VWStepElement
Determines whether a specific parameter exists.
HOURS - Static variable in class filenet.vw.api.VWTimeUnitType
Value of 2. Specifies hours as the time unit.

I

initializeRegion() - Method in class filenet.vw.api.VWSystemAdministration
Initializes the current region.
insertField(VWFieldDefinition) - Method in class filenet.vw.api.VWWorkflowDefinition
Inserts a field in this workflow definition.
insertMap(VWMapDefinition) - Method in class filenet.vw.api.VWWorkflowDefinition
Inserts a map in this workflow definition.
insertMilestone(VWMilestoneDefinition) - Method in class filenet.vw.api.VWWorkflowDefinition
Inserts a milestone in this workflow definition.
isArray() - Method in class filenet.vw.api.VWParameter
Determines whether this parameter is of type array.
isArray() - Method in interface filenet.vw.api.IVWField
Get the value of the isArray flag.
isArray() - Method in class filenet.vw.api.VWDataField
Determines whether the data field is an array.
isArray() - Method in class filenet.vw.api.VWFieldDefinition
Gets the value of the isArray flag.
isCompoundStep() - Method in class filenet.vw.api.VWStepHistory
Indicates whether the step type of the current history object is a compound step.
isDefaultType() - Method in class filenet.vw.api.VWStepProcessorInfo
Indicates whether or not the step processor is a default step or launch processor.
isDefaultType() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Determine whether or not the step processor is a default step or default launch processor.
isDone() - Method in class filenet.vw.api.VWRosterQuery
Deprecated. Replaced by VWRosterQuery.next().
isDone() - Method in class filenet.vw.api.VWQueueQuery
Deprecated. Replaced by VWQueueQuery.next()
isFieldArray(String) - Method in class filenet.vw.api.VWAttributeInfo
Determines whether a field is an array.
isFieldArray(String) - Method in class filenet.vw.api.VWUserInfo
Determines whether a field is an array.
isInstructionSheetName(String) - Method in class filenet.vw.api.VWWorkflowSignature
Checks for the existence of a named instruction sheet in this VWWorkflowSignature's list of instruction sheet names.
isLoggedOn() - Method in class filenet.vw.api.VWSession
Checks whether this session is currently logged on or not.
isMandatorySystemField() - Method in class filenet.vw.api.VWExposedFieldDefinition
Indicates whether the system data field is a mandatory or not.
isMandatorySystemIndex() - Method in class filenet.vw.api.VWIndexDefinition
Indicates whether or not the index is a mandatory system index.
isMemberOfGroup(String) - Method in class filenet.vw.api.VWSession
Determines whether or not the logged on user is a member of a specific group.
isSystemField() - Method in class filenet.vw.api.VWExposedFieldDefinition
Determines whether the data field is a system field.
isSystemField(String) - Method in class filenet.vw.api.VWQueueElement
Determines whether the field data type is a system field.
isSystemField(String) - Method in class filenet.vw.api.VWRosterElement
Determines whether the field is a system field.
isSystemIndex() - Method in class filenet.vw.api.VWIndexDefinition
Indicates whether or not the index is a system index.
isSystemParameter() - Method in class filenet.vw.api.VWParameter
Indicates whether this parameter is of type "system parameter".
isUserLoggingOption(int) - Static method in class filenet.vw.api.VWLoggingOptionType
Determines whether or not the logging option type is one of the available user log message types.
isValid(int) - Static method in class filenet.vw.api.VWQueueDefinition
Validates the queue type a valid type.
isValid(int) - Static method in class filenet.vw.api.VWOperationType
Validates the specified operation type.
isValid(int) - Static method in class filenet.vw.api.VWMergeType
Validates the specified merge type.
isValid(int) - Static method in class filenet.vw.api.VWModeType
Validates the mode type.
isValid(int) - Static method in class filenet.vw.api.VWAttachmentType
Validates whether the input value is a valid attachment type.
isValid(int) - Static method in class filenet.vw.api.VWFieldType
Validates an integer to insure that it is valid field type.
isValid(int) - Static method in class filenet.vw.api.VWLibraryType
Validates the specified library or Object Store type.
isValid(int) - Static method in class filenet.vw.api.VWTimeUnitType
Checks that a time unit type is within a valid range.
isValid(int) - Static method in class filenet.vw.api.VWNodeType
Returns whether or not the node type is valid.
isValid(int) - Static method in class filenet.vw.api.VWJoinType
Checks whether or not the specified join type value is valid.
isValid(int) - Static method in class filenet.vw.api.VWFetchType
Determines if the specified integer value is valid.
isValid(int) - Static method in class filenet.vw.api.VWUserInfo
Determines whether the specified notification type is valid.
isValid(int) - Static method in class filenet.vw.api.VWActionType
Validates an action.
isValid(int) - Static method in class filenet.vw.api.VWSplitType
Determines whether or not the split type is in range.
isValid(Object) - Static method in class filenet.vw.api.VWFieldType
Validates whether the passed object type matches one of valid the field types.
isValidName(String) - Static method in class filenet.vw.api.VWFieldType
Validates the input string as a properly formed field name.
IVWField - interface filenet.vw.api.IVWField.
The IVWField class provides a definition for field values.
IVWTableDefinition - interface filenet.vw.api.IVWTableDefinition.
The VWTableDefinition class provides the definition for database tables.
IVWtoXML - interface filenet.vw.api.IVWtoXML.
The IVWtoXML provides a way to identify which VW api objects implement toXML() methods.

J

JOIN_TYPE_AND - Static variable in class filenet.vw.api.VWJoinType
Value of 1. Indicates a join where work is received from multiple paths which must all be traversed.
JOIN_TYPE_NONE - Static variable in class filenet.vw.api.VWJoinType
Value of 3. Indicates there is no join at the step.
JOIN_TYPE_OR - Static variable in class filenet.vw.api.VWJoinType
Value of 2. Indicates a branch where work will be received from one among more than one paths.

L

LIBRARY_TYPE_CONTENT_ENGINE - Static variable in class filenet.vw.api.VWLibraryType
Value of 3. The library or Object Store is a Content Engine library.
LIBRARY_TYPE_IDMDS - Static variable in class filenet.vw.api.VWLibraryType
Value of 2. The library is a Content Services (CS) library (Content Services was formerly known as Document Services).
LIBRARY_TYPE_IDMIS - Static variable in class filenet.vw.api.VWLibraryType
Value of 1. The library is an Image Services (IS) library.
LIBRARY_TYPE_UNDEFINED - Static variable in class filenet.vw.api.VWLibraryType
Value of 0. The library type is unknown or undefined.
lock(boolean) - Method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.doLock( boolean)
lock(boolean) - Method in class filenet.vw.api.VWInstructionElement
Deprecated. Replaced by VWInstructionElement.doLock(boolean)
LOCKED_BY_NONE - Static variable in class filenet.vw.api.VWQueueElement
Value of 0.
LOCKED_BY_SYSTEM - Static variable in class filenet.vw.api.VWQueueElement
Value of 2.  This value indicates whether a workflow object is locked by the system.
LOCKED_BY_USER - Static variable in class filenet.vw.api.VWQueueElement
Value of 1.  This value indicates whether a workflow object is locked by a user.
lockMany(VWInstructionElement[], boolean) - Static method in class filenet.vw.api.VWInstructionElement
Deprecated. Replaced by VWInstructionElement.doLockMany(VWInstructionElement[], boolean)
lockMany(VWWorkObject[], boolean) - Static method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.doLockMany(VWWorkObject[], boolean)
LOG_ALL - Static variable in class filenet.vw.api.VWSystemConfiguration
Integer value that is the sum of all the other logging options. Enables logging for all selections.
LOG_BEGIN_SERVICE_OPERATION - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x00100000 (1048576 decimal). Enables logging when a work performer and work object begin operation.
LOG_END_SERVICE_OPERATION - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x00400000 (4194304 decimal). Enables logging when work performer and work object end operation.
LOG_MILESTONES - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x00000040 (64 decimal). Enables logging for milestones.
LOG_NONE - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0. Disables logging for all selections.
LOG_SYSTEM_MESSAGES - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x00010000 (65536 decimal). Enables logging for system messages.
LOG_USER_DEFINED_1 - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x40000000 (1073741824 decimal). Enables logging for user-defined message 1.
LOG_USER_DEFINED_2 - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x80000000 (2147483648 decimal). Enables logging for user-defined message 2.
LOG_WOBJ_ADMINISTRATION - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x00001000 ( 4096 decimal). Enables logging for work object administration messages.
LOG_WOBJ_CREATION - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x00000100 (256 decimal). Enables logging for work object creation.
LOG_WOBJ_EXCEPTION - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x00000400 (1024 decimal). Enables logging for work object exceptions.
LOG_WOBJ_TERMINATION - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x00000200 (512 decimal). Enables logging for work object termination.
LOG_WOBJ_TRACE_INSTRUCTIONS - Static variable in class filenet.vw.api.VWSystemConfiguration
Value of 0x00000020 (32 decimal). Enables logging for work object trace instructions.
LOGGING_OPTION_TYPE_USER1_MESSAGE1 - Static variable in class filenet.vw.api.VWLoggingOptionType
Value of 410. Specifies this optionlogs message 1 of user 1 on the server.
LOGGING_OPTION_TYPE_USER1_MESSAGE2 - Static variable in class filenet.vw.api.VWLoggingOptionType
Value of 420. Specifies this optionlogs message 2 of user 1 on the server.
LOGGING_OPTION_TYPE_USER1_MESSAGE3 - Static variable in class filenet.vw.api.VWLoggingOptionType
Value of 430. Specifies this optionlogs message 3 of user 1 on the server.
LOGGING_OPTION_TYPE_USER1_MESSAGE4 - Static variable in class filenet.vw.api.VWLoggingOptionType
Value of 440. Specifies this optionlogs message 4 of user 1 on the server.
LOGGING_OPTION_TYPE_USER2_MESSAGE1 - Static variable in class filenet.vw.api.VWLoggingOptionType
Value of 450. Specifies this optionlogs message 1 of user 2 on the server.
LOGGING_OPTION_TYPE_USER2_MESSAGE2 - Static variable in class filenet.vw.api.VWLoggingOptionType
Value of 460. Specifies this optionlogs message 2 of user 2 on the server.
LOGGING_OPTION_TYPE_USER2_MESSAGE3 - Static variable in class filenet.vw.api.VWLoggingOptionType
Value of 470. Specifies this optionlogs message 3 of user 2 on the server.
LOGGING_OPTION_TYPE_USER2_MESSAGE4 - Static variable in class filenet.vw.api.VWLoggingOptionType
Value of 480. Specifying this option logs message 4 of user 2 on the server.
logMessage(int, String) - Method in class filenet.vw.api.VWInstructionElement
Logs a message to the default server log.
logoff() - Method in class filenet.vw.api.VWSession
Ends the session with the Process Engine and frees all resources.
logon(String, String, String) - Method in class filenet.vw.api.VWSession
Logs onto an existing session.
logonWithToken(String, String) - Method in class filenet.vw.api.VWSession
For FileNet Web Services and Open Client only, this method can establish a shared logon session.
LVALUE - Static variable in class filenet.vw.api.VWEventDefinition
Value of 0: this constant can be used to subscript into the left-hand side values of an event assignment array.
LVALUE - Static variable in class filenet.vw.api.VWStepDefinition
Value of 0: this constant can be used as a subscript for the pre or post assignment arrays.
LVALUE - Static variable in class filenet.vw.api.VWWorkflowDefinition
Value of 0: this constant can be used to subscript into the pre or post assignment arrays.
lValue(String, VWWorkflowSignature, VWWorkflowDefinition) - Static method in class filenet.vw.api.VWFieldType
Determines whether an expression is a valid as an array or single value on the left (target) side of an assignment statement.

M

makeXMLBlock(IVWtoXML) - Static method in class filenet.vw.api.VWXMLUtil
Creates an XML block from a filenet.vw.api object that implements the IVWtoXML interface.
makeXMLBlock(IVWtoXML[], String) - Static method in class filenet.vw.api.VWXMLUtil
Creates XML header information and XML for each of the objects contained in an input array of filenet.vw.api objects that implement the IVWtoXML interface.
MERGE_TYPE_ADD - Static variable in class filenet.vw.api.VWMergeType
Value of 5. Indicates an Add merge type.
MERGE_TYPE_APPEND - Static variable in class filenet.vw.api.VWMergeType
Value of 2. Indicates an Append merge type.
MERGE_TYPE_APPEND_NO_DUP - Static variable in class filenet.vw.api.VWMergeType
Value of 6. Indicates an Append without Duplicates merge type.
MERGE_TYPE_DEFAULT - Static variable in class filenet.vw.api.VWMergeType
Value of 1. Indicates a Default merge type.
MERGE_TYPE_OVERRIDE - Static variable in class filenet.vw.api.VWMergeType
Value of 3. Indicates an Override merge type.
MERGE_TYPE_OVERRIDE_ENTRY - Static variable in class filenet.vw.api.VWMergeType
Value of 4. Indicates an Override entry merge type.
MINUTES - Static variable in class filenet.vw.api.VWTimeUnitType
Value of 1. Specifies minutes the time unit.
MODE_IN - Static variable in class filenet.vw.api.VWInstructionElement
Value of 1: indicates that the field has an IN mode.
MODE_IN_OUT - Static variable in class filenet.vw.api.VWInstructionElement
Value of 3: indicates that the field has an IN and OUT mode.
MODE_OUT - Static variable in class filenet.vw.api.VWInstructionElement
Value of 2: indicates that the field has an OUT mode.
MODE_TYPE_IN - Static variable in class filenet.vw.api.VWModeType
Value of 1. Indicates that the argument is an input parameter, which is passed by value.
MODE_TYPE_IN_OUT - Static variable in class filenet.vw.api.VWModeType
Value of 3. Indicates that the argument is an input/output parameter, which is passed by reference.
MODE_TYPE_OUT - Static variable in class filenet.vw.api.VWModeType
Value of 2. Indicates that the argument is an output parameter, which is passed by reference.
MONTHS - Static variable in class filenet.vw.api.VWTimeUnitType
Value of 5. Specifies months as the time unit.

N

next() - Method in class filenet.vw.api.VWStepHistory
Retrieves the subsequent element for this VWStepHistory instance. Invoke this method repeatedly to retrieve a series of VWStepOccurrenceHistory objects.
next() - Method in class filenet.vw.api.VWRosterQuery
Retrieves the subsequent element for this VWRosterQuery instance. Invoke this method repeatedly to retrieve a series of objects that can be cast to the fetch type of this VWRosterQuery object, as specified by the VWRoster.createQuery(String, Object[], Object[], int, String, Object[], int) call that created this VWRosterQuery instance.
next() - Method in class filenet.vw.api.VWWorkflowHistory
Retrieves the subsequent element for this VWWorkflowHistory instance. Invoke this method repeatedly to retrieve a series of VWStepHistory objects.
next() - Method in class filenet.vw.api.VWQueueQuery
Retrieves the subsequent element for this VWQueueQuery instance. Invoke this method repeatedly to retrieve a series of objects that can be cast to the fetch type of this VWQueueQuery object, as specified by the VWQueue.createQuery(String, Object[], Object[], int, String, Object[], int) call that created this VWQueueQuery instance.
next() - Method in class filenet.vw.api.VWProcess
Retrieves the subsequent work object in the series of active work objects associated with this process. Invoke this method repeatedly to retrieve a series of active work objects. Returns null when no more active work objects can be returned.
next() - Method in class filenet.vw.api.VWLogQuery
Gets the next log element in the collection (if one exists).
next() - Method in class filenet.vw.api.VWWorkflowMilestones
Returns the next element in an iterated series of VWMilestoneElement members that belong to the current instance of the VWWorkflowMilestones class.
next() - Method in class filenet.vw.api.VWStepWorkObjectHistory
Retrieves the subsequent element for this VWStepWorkObjectHistory instance. Invoke this method repeatedly to retrieve a series of VWParticipantHistory objects.
next() - Method in class filenet.vw.api.VWSecurityList
Retrieves the subsequent element for the current VWSecurityList instance. Invoke this method repeatedly to retrieve a series of objects that should be cast to a String type.
next() - Method in class filenet.vw.api.VWStepOccurrenceHistory
Retrieves the subsequent element for this VWStepOccurrenceHistory instance. Invoke this method repeatedly to retrieve a series of VWStepWorkObjectHistory objects.
NODE_TYPE_LAUNCH - Static variable in class filenet.vw.api.VWNodeType
Value of 1
The node is a launch node, which is the first step in the main workflow definition map, which is called "Workflow".
NODE_TYPE_OTHER - Static variable in class filenet.vw.api.VWNodeType
Value of 3
The node is neither a start nor a launch node.
NODE_TYPE_START - Static variable in class filenet.vw.api.VWNodeType
Value of 2
The node is a start node, which is the first step in any workflow definition map other than the main map.
NOTIFICATION_MILESTONE_ORIGINATOR - Static variable in class filenet.vw.api.VWUserInfo
Value of 512: signifies the notification flag is "Originator Milestone".
NOTIFICATION_MILESTONE_TRACKER - Static variable in class filenet.vw.api.VWUserInfo
Value of 256: signifies the notification flag is "Tracker Milestone".
NOTIFICATION_STEP_EXPIRED_DEADLINE - Static variable in class filenet.vw.api.VWUserInfo
Value of 2: signifies the notification flag is "Step Expired Deadline".
NOTIFICATION_STEP_NEW_ASSIGNMENT - Static variable in class filenet.vw.api.VWUserInfo
Value of 1: signifies the notification flag is "Step New Assignment".
NOTIFICATION_STEP_REMINDERS - Static variable in class filenet.vw.api.VWUserInfo
Value of 4: signifies the notification flag is "Step Reminders".
NOTIFICATION_TRACKER_EXPIRED_DEADLINE - Static variable in class filenet.vw.api.VWUserInfo
Value of 16: signifies the notification flag is "Tracker Expired Deadline".
NOTIFICATION_TRACKER_NEW_ASSIGNMENT - Static variable in class filenet.vw.api.VWUserInfo
Value of 32: signifies the notification flag is "Tracker New Assignment".
NOTIFICATION_TRACKER_REMINDERS - Static variable in class filenet.vw.api.VWUserInfo
Value of 64: signifies the notification flag is "Tracker Reminders".
NOTIFICATION_TRACKER_STEP_EXPIRED_DEADLINE - Static variable in class filenet.vw.api.VWUserInfo
Value of 128: signifies the notification flag is "Tracker Step Expired Deadline".
NOTIFICATION_TRACKER_WORKFLOW_EXCEPTION - Static variable in class filenet.vw.api.VWUserInfo
Value of 8: signifies the notification flag is "Tracker Workflow Exception".
NOTIFICATION_UNDEFINED - Static variable in class filenet.vw.api.VWUserInfo
Value of 0: signifies the notification flag is "Undefined".
numberOfParameters(int) - Static method in class filenet.vw.api.VWActionType
Gets the number of parameters required for an action or the flag value, VWActionType.VARIABLE_PARAMS (999), if the action type takes a variable number of parameters.

O

OP_TYPE_ASSIGN - Static variable in class filenet.vw.api.VWOperationType
Value of 0.
OP_TYPE_BEGIN_SEQMODE - Static variable in class filenet.vw.api.VWOperationType
Value of 31.
OP_TYPE_BEGIN_TIMER - Static variable in class filenet.vw.api.VWOperationType
Value of 1.
OP_TYPE_BEGINCHECKPOINT - Static variable in class filenet.vw.api.VWOperationType
Value of 27.
OP_TYPE_BINDTOSTATION - Static variable in class filenet.vw.api.VWOperationType
Value of 2.
OP_TYPE_BINDTOUSER - Static variable in class filenet.vw.api.VWOperationType
Value of 3.
OP_TYPE_BRANCH - Static variable in class filenet.vw.api.VWOperationType
Value of 4.
OP_TYPE_CALL - Static variable in class filenet.vw.api.VWOperationType
Value of 5.
OP_TYPE_CREATE - Static variable in class filenet.vw.api.VWOperationType
Value of 6.
OP_TYPE_DELAY_INST - Static variable in class filenet.vw.api.VWOperationType
Value of 7.
OP_TYPE_END_SEQMODE - Static variable in class filenet.vw.api.VWOperationType
Value of 32.
OP_TYPE_ENDALLTIMERS - Static variable in class filenet.vw.api.VWOperationType
Value of 8.
OP_TYPE_ENDCHECKPOINT - Static variable in class filenet.vw.api.VWOperationType
Value of 28.
OP_TYPE_ENDTIMER - Static variable in class filenet.vw.api.VWOperationType
Value of 9.
OP_TYPE_ENDWHILE - Static variable in class filenet.vw.api.VWOperationType
Value of 21.
OP_TYPE_GOTO - Static variable in class filenet.vw.api.VWOperationType
Value of 10.
OP_TYPE_LABEL - Static variable in class filenet.vw.api.VWOperationType
Value of 11.
OP_TYPE_LEAF - Static variable in class filenet.vw.api.VWOperationType
Value of 26.
OP_TYPE_NONE - Static variable in class filenet.vw.api.VWOperationType
Value of 25.
OP_TYPE_NONOP - Static variable in class filenet.vw.api.VWOperationType
Value of 24.
OP_TYPE_RELEASE - Static variable in class filenet.vw.api.VWOperationType
Value of 12.
OP_TYPE_RENDEZVOUS - Static variable in class filenet.vw.api.VWOperationType
Value of 22.
OP_TYPE_RESUMETIMER - Static variable in class filenet.vw.api.VWOperationType
Value of 13.
OP_TYPE_RETURN - Static variable in class filenet.vw.api.VWOperationType
Value of 14.
OP_TYPE_ROLLBACKCHECKPOINT - Static variable in class filenet.vw.api.VWOperationType
Value of 29.
OP_TYPE_STATICSPLIT - Static variable in class filenet.vw.api.VWOperationType
Value of 15.
OP_TYPE_STEP - Static variable in class filenet.vw.api.VWOperationType
Value of 33.
OP_TYPE_STOP - Static variable in class filenet.vw.api.VWOperationType
Value of 30.
OP_TYPE_SUSPENDTIMER - Static variable in class filenet.vw.api.VWOperationType
Value of 16.
OP_TYPE_TERMINATE - Static variable in class filenet.vw.api.VWOperationType
Value of 17 .
OP_TYPE_UNBIND - Static variable in class filenet.vw.api.VWOperationType
Value of 18.
OP_TYPE_USERDEFINED - Static variable in class filenet.vw.api.VWOperationType
Value of 23.
OP_TYPE_WAITFOREVENT - Static variable in class filenet.vw.api.VWOperationType
Value of 19.
OP_TYPE_WHILE - Static variable in class filenet.vw.api.VWOperationType
Value of 20.
optionalSystemFields() - Static method in class filenet.vw.api.VWQueueDefinition
Gets definitions of optional exposed queue fields.
optionalSystemFields() - Static method in class filenet.vw.api.VWLogDefinition
Returns workflow system exposed fields, which are marked as optional.
optionalSystemFields() - Static method in class filenet.vw.api.VWRosterDefinition
Returns workflow system exposed fields that are marked as optional.

P

pasteSteps(String) - Method in class filenet.vw.api.VWMapDefinition
Pastes steps into the workflow definition.
POST_RULESETS - Static variable in class filenet.vw.api.VWMapNode
Value of 2, for use with VWMapNode.getRuleSets(int) and VWMapNode.setRuleSets(int, VWRuleSetDefinition []).
PRE_RULESETS - Static variable in class filenet.vw.api.VWMapNode
Value of 0, for use with VWMapNode.getRuleSets(int) and VWMapNode.setRuleSets(int, VWRuleSetDefinition []).
PROCESSOR_DEFAULT - Static variable in class filenet.vw.api.VWStepProcessorInfo
Value of 3. This value specifies the default launch and the default step processor.
PROCESSOR_DEFAULT - Static variable in class filenet.vw.api.VWStepProcessorInfoDefinition
Value of 3. This value indicates default launch and step processors. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...) methods refer to these static variables.
PROCESSOR_LAUNCH - Static variable in class filenet.vw.api.VWStepProcessorInfo
Value of 4. This value specifies the non-default launch step processor.
PROCESSOR_LAUNCH - Static variable in class filenet.vw.api.VWStepProcessorInfoDefinition
Value of 4. This value indicates that the step is the non-default launch step processor.
PROCESSOR_LAUNCH_DEFAULT - Static variable in class filenet.vw.api.VWStepProcessorInfo
Value of 1. This value specifies the default launch step processor.
PROCESSOR_LAUNCH_DEFAULT - Static variable in class filenet.vw.api.VWStepProcessorInfoDefinition
Value of 1. This value indicates that the step is the default launch step processor. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...) methods refer to these static variables.
PROCESSOR_STEP - Static variable in class filenet.vw.api.VWStepProcessorInfo
Value of 8. This value specifies the non-default step processor.
PROCESSOR_STEP - Static variable in class filenet.vw.api.VWStepProcessorInfoDefinition
Value of 8. This value indicates a non-default step processor. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...) methods refer to these static variables.
PROCESSOR_STEP_DEFAULT - Static variable in class filenet.vw.api.VWStepProcessorInfo
Value of 2. This value specifies the default step processor.
PROCESSOR_STEP_DEFAULT - Static variable in class filenet.vw.api.VWStepProcessorInfoDefinition
Value of 2. This value indicates a default step processor. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...) methods refer to these static variables.
PRODUCT_BPS - Static variable in class filenet.vw.api.VWSession
Deprecated. Replaced by use of VWSession.setDefaultWebApplication(int)
PRODUCT_CUSTOM - Static variable in class filenet.vw.api.VWSession
Deprecated. Replaced by use of VWSession.setDefaultWebApplication(int)
PRODUCT_OPEN_CLIENT - Static variable in class filenet.vw.api.VWSession
Deprecated. Replaced by use of VWSession.setDefaultWebApplication(int)
PRODUCT_PW - Static variable in class filenet.vw.api.VWSession
Deprecated. Replaced by use of VWSession.setDefaultWebApplication(int)
propBundleHashTable - Static variable in class filenet.vw.api.VWException
 

Q

QUERY_GET_NO_SYSTEM_FIELDS - Static variable in class filenet.vw.api.VWRoster
Value of 1024. Include this value in the queryFlags parameter of the createQuery() method to return objects without system fields.
QUERY_GET_NO_SYSTEM_FIELDS - Static variable in class filenet.vw.api.VWQueue
Value of 1024. Include this value in the queryFlags parameter of the createQuery() method of the startQuery() method to return objects without system fields.
QUERY_GET_NO_TRANSLATED_SYSTEM_FIELDS - Static variable in class filenet.vw.api.VWRoster
Value of 2048. Include this value in the queryFlags parameter of the createQuery() method to return objects without translated fields.
QUERY_GET_NO_TRANSLATED_SYSTEM_FIELDS - Static variable in class filenet.vw.api.VWQueue
Value of 2048. Include this value in the queryFlags parameter of the createQuery() method to return objects without translated fields.
QUERY_GET_SYSTEM_FIELDS - Static variable in class filenet.vw.api.VWRoster
Deprecated. Not replaced. This is the default.
QUERY_GET_SYSTEM_FIELDS - Static variable in class filenet.vw.api.VWQueue
Deprecated. Not replaced. This is the default.
QUERY_GET_TRANSLATED_SYSTEM_FIELDS - Static variable in class filenet.vw.api.VWRoster
Deprecated. Not replaced. This is the default.
QUERY_GET_TRANSLATED_SYSTEM_FIELDS - Static variable in class filenet.vw.api.VWQueue
Deprecated. Not replaced. This is the default.
QUERY_LOCK_OBJECTS - Static variable in class filenet.vw.api.VWQueue
Value of 16. Include this value in the queryFlags parameter of the createQuery() method to lock the work items returned from a search.
QUERY_MAX_VALUES_INCLUSIVE - Static variable in class filenet.vw.api.VWRoster
Value of 64. Pass this value in the queryFlags parameter of the createQuery method to specify the inclusion of maximum search values.
QUERY_MAX_VALUES_INCLUSIVE - Static variable in class filenet.vw.api.VWQueue
Value of 64. Include this value in the queryFlags parameter of the createQuery() method to include maximum search values.
QUERY_MAX_VALUES_INCLUSIVE - Static variable in class filenet.vw.api.VWLog
Value of 64. This value is used as a possible value for the queryFlags parameter of the startQuery method.
QUERY_MIN_VALUES_INCLUSIVE - Static variable in class filenet.vw.api.VWRoster
Value of 32. Pass this value in the queryFlags parameter of the createQuery method to specify the inclusion of minimum search values.
QUERY_MIN_VALUES_INCLUSIVE - Static variable in class filenet.vw.api.VWQueue
Value of 32. Include this value in the queryFlags parameter of the createQuery() method to include minimum search values.
QUERY_MIN_VALUES_INCLUSIVE - Static variable in class filenet.vw.api.VWLog
Interger value of 32. This value is used as a possible value for the queryFlags parameter of the startQuery method.
QUERY_NO_OPTIONS - Static variable in class filenet.vw.api.VWRoster
Value of 0. Pass this value in the queryFlags parameter of the createQuery method to specify no search option.
QUERY_NO_OPTIONS - Static variable in class filenet.vw.api.VWQueue
Value of 0. Pass this value as the queryFlags parameter of the createQuery() method to use the no search options option.
QUERY_NO_OPTIONS - Static variable in class filenet.vw.api.VWLog
Value of 0. This value is used as a possible value for the queryFlags parameter of the startQuery method.
QUERY_READ_BOUND - Static variable in class filenet.vw.api.VWQueue
Value of 2. Include this value in the queryFlags parameter of the createQuery() method to return work items that are bound to a user or machine.
QUERY_READ_LOCKED - Static variable in class filenet.vw.api.VWQueue
Value of 1. Include this value in the queryFlags parameter of the createQuery() method to return locked and unlocked work items.
QUERY_READ_UNWRITABLE - Static variable in class filenet.vw.api.VWRoster
Value of 4. Pass this value in the queryFlags parameter of the createQuery method to specify the return of Read-only work items.
QUERY_READ_UNWRITABLE - Static variable in class filenet.vw.api.VWQueue
Value of 4. Include this value in the queryFlags parameter of the createQuery() method to return writable and unwritable work items.
QUEUE_IGNORE_SECURITY - Static variable in class filenet.vw.api.VWSession
Value of 16. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of queues to which the user has no access.
QUEUE_ON_ALL_SERVERS - Static variable in class filenet.vw.api.VWQueueDefinition
Signed integer value of -1. Not a queue type, this field value indicates that the queue is located on all servers.
QUEUE_PROCESS - Static variable in class filenet.vw.api.VWSession
Value of 1. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each process queue (a queue that holds objects for an external workflow to process).
QUEUE_SYSTEM - Static variable in class filenet.vw.api.VWSession
Value of 4. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each system queue (a queue that the system configures).
QUEUE_TYPE_PROCESS - Static variable in class filenet.vw.api.VWQueueDefinition
Value of 1. This field value indicates a process queue type.
QUEUE_TYPE_PROCESS - Static variable in class filenet.vw.api.VWQueue
Value of 1. This value is returned by the getQueueType() method to indicate that the queue is a process queue.
QUEUE_TYPE_SYSTEM - Static variable in class filenet.vw.api.VWQueueDefinition
Value of 3. This field value indicates a System queue type.
QUEUE_TYPE_SYSTEM - Static variable in class filenet.vw.api.VWQueue
Value of 3. This value is returned by the getQueueType method to indicate that the queue is a system queue.
QUEUE_TYPE_USER_CENTRIC - Static variable in class filenet.vw.api.VWQueueDefinition
Value of 2. This field value indicates a user-centric queue type.
QUEUE_TYPE_USER_CENTRIC - Static variable in class filenet.vw.api.VWQueue
Value of 2. This value is returned by the getQueueType method to indicate that the queue is a user queue.
QUEUE_USER_CENTRIC - Static variable in class filenet.vw.api.VWSession
Value of 2. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each user queue (the individual queue of a workflow user, similar to a inbox for the user).
QUEUE_USER_CENTRIC_FOR_USER_ONLY - Static variable in class filenet.vw.api.VWSession
Value of 32. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of the user-centric queue associated with the user information.

R

read(InputStream) - Static method in class filenet.vw.api.VWWorkflowDefinition
Evaluates a workflow definition from an input stream.
readFromFile(String) - Static method in class filenet.vw.api.VWWorkflowDefinition
Evaluates a workflow definition from a file.
recoverUser(String, String[]) - Method in class filenet.vw.api.VWSession
Recovers a user, given a list of queue names like the list produced by VWSession.fetchQueueNames(int).
refresh(boolean, boolean) - Method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.doRefresh(boolean, boolean)
refresh(boolean, boolean) - Method in class filenet.vw.api.VWInstructionElement
Deprecated. Replaced by VWInstructionElement.doRefresh(boolean, boolean)
removeAllRegions() - Method in class filenet.vw.api.VWSystemAdministration
Deletes information for all isolated regions.
removeLinkFlag(String) - Method in class filenet.vw.api.VWSystemAdministration
Deletes the linked-document indicator from a transferred work space.
removeRegion() - Method in class filenet.vw.api.VWSystemAdministration
Deletes the current isolated region and information that pertains to it.
removeWorkflowDatabase() - Method in class filenet.vw.api.VWSystemAdministration
Deletes all workflow information from the database.
reorderRoutes(int[]) - Method in class filenet.vw.api.VWMapNode
Changes the order in which the system stores outbound routes in this map node.
resetFetch() - Method in class filenet.vw.api.VWStepHistory
Resets the last element fetched for the current step history object.
resetFetch() - Method in class filenet.vw.api.VWRosterQuery
Resets the last element fetched for this RosterQuery object.
resetFetch() - Method in class filenet.vw.api.VWWorkflowHistory
Resets the last element fetched for this step history object.
resetFetch() - Method in class filenet.vw.api.VWQueueQuery
Resets the last element fetched for this queue query object.
resetFetch() - Method in class filenet.vw.api.VWProcess
Sets the fetch items count to zero (0) so the application can refetch items.
resetFetch() - Method in class filenet.vw.api.VWLogQuery
Resets the last element fetched for the log query object.
resetFetch() - Method in class filenet.vw.api.VWWorkflowMilestones
Resets the last element fetched for this step history object.
resetFetch() - Method in class filenet.vw.api.VWStepWorkObjectHistory
Resets the last element fetched for this step history object.
resetFetch() - Method in class filenet.vw.api.VWSecurityList
Resets the last element fetched for this SecurityListQuery object.
resetFetch() - Method in class filenet.vw.api.VWStepOccurrenceHistory
Resets the last element fetched for this step history object.
RVALUE - Static variable in class filenet.vw.api.VWEventDefinition
Value of 1: this constant can be used to subscript into right-hand side values of an event assignment array.
RVALUE - Static variable in class filenet.vw.api.VWStepDefinition
Value of 1: this constant can be used as a subscript for the pre or post assignment arrays.
RVALUE - Static variable in class filenet.vw.api.VWWorkflowDefinition
Value of 1: this constant can be used to subscript into the pre or post assignment arrays.

S

save() - Method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.doSave(boolean)
save() - Method in class filenet.vw.api.VWInstructionElement
Deprecated. Replaced by VWInstructionElement.doSave(boolean)
save() - Method in class filenet.vw.api.VWNewWorkObject
Deprecated. Saves a new work object to the server.
save() - Method in class filenet.vw.api.VWUserInfo
Saves the values set for the current user.
saveMany(VWInstructionElement[]) - Static method in class filenet.vw.api.VWInstructionElement
Deprecated. Replaced by VWInstructionElement.doSaveMany(VWInstructionElement[])
SaveMany(VWNewWorkObject[], VWRoster, String, String) - Static method in class filenet.vw.api.VWNewWorkObject
Deprecated. Saves an array of new work objects.
saveMany(VWWorkObject[]) - Static method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.doSaveMany(VWWorkObject[])
SEARCH_TYPE_CONTAINS - Static variable in class filenet.vw.api.VWSession
Value of 4, indicating a pattern search would match when all of the characters in the pattern match, in order, to a corresponding series of characters in the name being compared, and that the name may contain additional alphanumeric characters before or after the matching series of characters.
SEARCH_TYPE_CUSTOM - Static variable in class filenet.vw.api.VWSession
Value of 1, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding characters in the name being compared, and that the name does not contain any characters before or after the matching characters.
SEARCH_TYPE_NONE - Static variable in class filenet.vw.api.VWSession
Value of 0, indicating a pattern search would match all user names and ignore the searchPattern string.
SEARCH_TYPE_PREFIX_MATCH - Static variable in class filenet.vw.api.VWSession
Value of 2, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding beginning series of characters in the name being compared, and that the name may contain additional alphanumeric characters after the matching series of characters.
SEARCH_TYPE_SUFFIX_MATCH - Static variable in class filenet.vw.api.VWSession
Value of 3, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding ending series of characters in the name being compared, and that the name may contain additional alphanumeric characters before the matching series of characters.
SEPARATOR - Static variable in class filenet.vw.api.VWAttachment
Insert this separator ('|' or hex 7C) between attributes of a string-formatted attachment, as in an XML file or an XML transfer stream to the server.
SERVER_ID_UNSPECIFIED - Static variable in class filenet.vw.api.VWUserInfo
Value of -1: signifies the Server ID is unspecified.
setApplicationName(String) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Sets the application name.
setAppType(int) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Sets the application type associated with this step processor's information.
setAssignments(String[][]) - Method in class filenet.vw.api.VWEventDefinition
Sets the assignments property value for the event.
setAttachmentDescription(String) - Method in class filenet.vw.api.VWAttachment
Sets the description for an attachment.
setAttachmentName(String) - Method in class filenet.vw.api.VWAttachment
Sets the document name for this attachment.
setAttributeInfo(VWAttributeInfo) - Method in class filenet.vw.api.VWQueueDefinition
Sets a VWAttribute object containing attributes for this object.
setAttributeInfo(VWAttributeInfo) - Method in class filenet.vw.api.VWSystemAdministration
Sets a VWAttribute object containing attributes for this object.
setAttributeInfo(VWAttributeInfo) - Method in class filenet.vw.api.VWStepDefinition
Sets a VWAttribute object containing attributes for this object.
setAttributeInfo(VWAttributeInfo) - Method in class filenet.vw.api.VWSystemConfiguration
Sets a VWAttribute object containing attributes for this object.
setAttributeInfo(VWAttributeInfo) - Method in class filenet.vw.api.VWOperationDefinition
Sets a VWAttribute object containing attributes for this object.
setAttributeInfo(VWAttributeInfo) - Method in class filenet.vw.api.VWWorkflowDefinition
Sets a VWAttribute object containing attributes for this object.
setAuditState(String, Integer[]) - Method in class filenet.vw.api.VWSession
Deprecated. Replaced by inserting a copy of the fnlogging.properties file in the <JRE>\lib directory. Edit this file to view or change logging properties. For detail information on the components of the fnlogging.properties file, see the Sun Javadoc documentation on the members of the java.util.logging class.
setAuthorTool(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Changes the value of this workflow definition's authorTool property.
setBaseWorkClassName(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Changes the value of this workflow definition's base work class name, which is the name of the work class from which this workflow definition will inherit upon transfer/ or initialization.
setBufferSize(int) - Method in class filenet.vw.api.VWStepHistory
Sets the maximum number of elements to return in a fetch.
setBufferSize(int) - Method in class filenet.vw.api.VWWorkflowHistory
Changes the maximum number of elements to return in a fetch.
setBufferSize(int) - Method in class filenet.vw.api.VWProcess
Sets the maximum number of elements to return in a fetch.  The default value is 100.
setBufferSize(int) - Method in class filenet.vw.api.VWRoster
Sets the integer value for the maximum number of elements to return in a fetch. The default value is 50.
setBufferSize(int) - Method in class filenet.vw.api.VWQueue
Sets the maximum number of elements to return in a fetch. The default number is 50.
setBufferSize(int) - Method in class filenet.vw.api.VWStepWorkObjectHistory
Sets the maximum number of elements to return in a fetch.
setBufferSize(int) - Method in class filenet.vw.api.VWLog
Sets the maximum number of elements to return in a fetch. The default number is 50.
setBufferSize(int) - Method in class filenet.vw.api.VWStepOccurrenceHistory
Sets the maximum number of elements to return in a fetch.
setCallISName(String) - Method in class filenet.vw.api.VWEventDefinition
Changes the value of this event's instruction sheet call property.
setCallMap(String) - Method in class filenet.vw.api.VWStepElement
Specifies a map to be called when the system dispatches this work object.
setCallMap(String) - Method in class filenet.vw.api.VWWorkObject
Specifies a map to be called when the system dispatches this work object.
setCanReassign(boolean) - Method in class filenet.vw.api.VWStepDefinition
Sets the canReassign property of the step: inputting TRUE will signify that the user can reassign the current step.
setCanViewHistory(boolean) - Method in class filenet.vw.api.VWStepDefinition
Sets the step's canViewHistory property to specify whether the user can view the history at this step.
setCanViewStatus(boolean) - Method in class filenet.vw.api.VWStepDefinition
Sets the step's canViewStatus property to specify whether the user can view the status of this step.
setCause(Throwable) - Method in class filenet.vw.api.VWException
 
setComment(String) - Method in class filenet.vw.api.VWStepElement
Sets the comment for this step.
setComparisonOperator(String) - Method in class filenet.vw.api.VWEventDefinition
Changes the value of this event's comparison operator.
setCompCall(String) - Method in class filenet.vw.api.VWRollbackInstruction
Initialize or modify the name of the compensation call instruction sheet for this rollback instruction.
setCondition(String) - Method in class filenet.vw.api.VWRouteDefinition
Sets the condition property.
setCreateSecurity(String[]) - Method in class filenet.vw.api.VWRosterDefinition
Sets Create access for the roster.
setDataFields(VWDataField[], boolean) - Method in class filenet.vw.api.VWWorkObject
Changes the values for specified data fields.
setDataType(int) - Method in class filenet.vw.api.VWParameterDefinition
Sets the data type for the parameter.
setDatePattern(String) - Static method in class filenet.vw.api.VWXMLUtil
Sets the date pattern format for runtime toXML methods, such as VWQueueElement.toXML(StringBuffer).
setDeadline(long) - Method in class filenet.vw.api.VWStepDefinition
Sets the deadline of this step.
setDeadline(long) - Method in class filenet.vw.api.VWWorkflowDefinition
Changes the value of the deadline property for this workflow definition.
setDeadlineExpr(String) - Method in class filenet.vw.api.VWStepDefinition
Sets the value of the deadline expression property for this step definition.
setDeadlineMap(String) - Method in class filenet.vw.api.VWStepDefinition
Changes the name of the map to be called when the step deadline expires for this step definition.
setDefaultType(int) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Sets the step processor default type.
setDefaultWebApplication(int) - Method in class filenet.vw.api.VWSession
Sets the default Web Application ID for a logged-on session; the default web application is applied to an initial transfer to a region.
setDescription(String) - Method in class filenet.vw.api.VWQueueDefinition
Sets the description for this queue definition.
setDescription(String) - Method in class filenet.vw.api.VWMapNode
Changes the value of the current node's description property.
setDescription(String) - Method in class filenet.vw.api.VWMapDefinition
Sets the description for the Workflow Map.
setDescription(String) - Method in class filenet.vw.api.VWParameterDefinition
Modifies the description for the parameter.
setDescription(String) - Method in class filenet.vw.api.VWLogDefinition
Sets the description for the log definition.
setDescription(String) - Method in interface filenet.vw.api.IVWTableDefinition
Sets the description for this table definition
setDescription(String) - Method in class filenet.vw.api.VWFieldDefinition
Modifies the String containing the description for the data field.
setDescription(String) - Method in class filenet.vw.api.VWOperationDefinition
Sets the description of this operation.
setDescription(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Changes the value of the description property of this workflow definition.
setDescription(String) - Method in class filenet.vw.api.VWRosterDefinition
Sets the description for this roster definition.
setDestinationStepId(int) - Method in class filenet.vw.api.VWRouteDefinition
Sets the integer value of the stepId property for the step destination.
setEMailAddress(String) - Method in class filenet.vw.api.VWUserInfo
Sets the email address of the current user.
setEventLogName(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Changes the value of the event log name for this workflow definition.
setEventNumLoc(String) - Method in class filenet.vw.api.VWWFEInstruction
Change the value of this instruction's eventNumLoc expression property.
setEvents(VWEventDefinition[]) - Method in class filenet.vw.api.VWWFEInstruction
Sets the events contained in this VWWFEInstruction instance.
setException(String, String) - Method in class filenet.vw.api.VWStepElement
Sets an exception condition for the work item that corresponds to the workflow map associated with this step element.
setException(String, String) - Method in class filenet.vw.api.VWWorkObject
Sets an exception condition for a work object.
setException(String, String) - Method in class filenet.vw.api.VWInstructionElement
Sets a exception condition for the workflow object specified by the Instruction Element.
setFieldNames(String[]) - Method in class filenet.vw.api.VWIndexDefinition
Sets the index definition to the specified field names. You must order the array so the field names reflect the sorting order, with the major index element as the first element in the array.
setFieldValue(String, Object) - Method in class filenet.vw.api.VWAttributeInfo
Initializes, updates, or deletes an attribute.
setFieldValue(String, Object) - Method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.setFieldValue(String, Object, boolean)
setFieldValue(String, Object) - Method in class filenet.vw.api.VWInstructionElement
Sets a value for the specified field.
setFieldValue(String, Object) - Method in class filenet.vw.api.VWNewWorkObject
Deprecated. Sets a value in the specified data field.
setFieldValue(String, Object) - Method in class filenet.vw.api.VWUserInfo
Creates, deletes, or updates a UserInfo field.
setFieldValue(String, Object, boolean) - Method in class filenet.vw.api.VWWorkObject
Changes the value of a specified data field.
setHasChanged(boolean) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Sets the hasChanged property value.
setHeight(int) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Sets the height of the step processor.
setId(String) - Method in class filenet.vw.api.VWAttachment
Sets the document ID associated with the attachment.
setIgnoreInvalidUsers(boolean) - Method in class filenet.vw.api.VWStepDefinition
Sets the ignoreInvalidUsers property of the step: inputting TRUE will signify that an invalid participant in this step at runtime will not cause an exception.
setInstructions(VWInstructionDefinition[]) - Method in class filenet.vw.api.VWCompoundStepDefinition
Changes the list instructions (as shown by VWCompoundStepDefinition.getInstructions()) contained in this VWCompoundStepDefinition instance, without adding or deleting members: the number of elements in the list does not change.
setIsArray(boolean) - Method in class filenet.vw.api.VWParameterDefinition
Sets the isArray flag on the parameter.
setIsConnectorQueue(boolean) - Method in class filenet.vw.api.VWQueueDefinition
Sets the isConnectorQueue flag.
setJoinType(int) - Method in class filenet.vw.api.VWMapNode
Changes the value of this step's JoinType property.
setLength(int) - Method in class filenet.vw.api.VWExposedFieldDefinition
Sets the byte length of string data to be stored in the search data field.
setLevel(int) - Method in class filenet.vw.api.VWMilestoneDefinition
Sets the level for the milestone.
setLibraryName(String) - Method in class filenet.vw.api.VWAttachment
Sets the name of the library or object store associated with this attachment.
setLibraryType(int) - Method in class filenet.vw.api.VWAttachment
Sets the library or object store type for the library or object store containing this attachment.
setLocation(Point) - Method in class filenet.vw.api.VWMapNode
Sets the value of the location property associated with this step.
setLocation(String) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Deprecated. Replaced by VWStepProcessorInfoDefinition.setLocations(Hashtable).
setLocations(Hashtable) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Sets the URL locations associated with this step processor, for each web application.
setLoggingState(int, boolean) - Method in class filenet.vw.api.VWSystemConfiguration
Enables or disables system logging options.
setMainAttachmentName(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Modifies the value of the main attachment name property of this workflow definition.
setMaxDBOperations(int) - Method in class filenet.vw.api.VWSystemConfiguration
Sets the maximum number of database operations executed by the instruction sheet interpreter per transaction, which is used to maximize throughput between the workstation and the server.
setMaxInstructions(int) - Method in class filenet.vw.api.VWSystemConfiguration
Sets the maximum number of instructions executed by the instruction sheet interpreter per transaction, which is used to setting to maximize throughput between the workstation and server.
setMergeType(int) - Method in class filenet.vw.api.VWFieldDefinition
Modifies the merge type property for the data field.
setMessage(String) - Method in class filenet.vw.api.VWMilestoneDefinition
Sets the message for the milestone. The message expression is evaluated and the result logged when the milestone is reached at runtime.
setMilestones(VWMilestoneDefinition[]) - Method in class filenet.vw.api.VWWorkflowDefinition
Sets the array of milestones for this workflow definition by reordering but not adding or deleting milestones, with the following Restriction:
setMode(int) - Method in class filenet.vw.api.VWParameterDefinition
Sets the mode for the parameter.
setName(String) - Method in class filenet.vw.api.VWMilestoneDefinition
Sets the name for the milestone.
setName(String) - Method in class filenet.vw.api.VWRouteDefinition
Sets the route name by modifying the name property.
setName(String) - Method in class filenet.vw.api.VWMapNode
Changes the value of the current node's name property.
setName(String) - Method in class filenet.vw.api.VWMapDefinition
Sets the name for the Workflow Map.
setName(String) - Method in class filenet.vw.api.VWParameterDefinition
Renames this parameter.
setName(String) - Method in class filenet.vw.api.VWUserInfo
Sets the name of the current user.
setName(String) - Method in class filenet.vw.api.VWFieldDefinition
Changes the data field name property.
setName(String) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Sets the name associated with this step processor's information object.
setName(String) - Method in class filenet.vw.api.VWOperationDefinition
Sets the name of this operation.
setName(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Changes the value of the name property for this workflow definition.
setNotificationFlags(int) - Method in class filenet.vw.api.VWUserInfo
Sets the notification flag settings for the current user.
setOperationName(String) - Method in class filenet.vw.api.VWStepDefinition
Sets (or associates) an operation with the current step.
setOperationParameters(String[]) - Method in class filenet.vw.api.VWStepDefinition
Sets an array of Strings containing the parameter expressions for the operation associated with this step.
setParameters(VWParameter[], boolean) - Method in class filenet.vw.api.VWStepElement
Sets the values for specified parameters in an array.
setParameterValue(String, Object, boolean) - Method in class filenet.vw.api.VWStepElement
Sets a value for a specified parameter.
setParams(String[]) - Method in class filenet.vw.api.VWSimpleInstruction
Changes the value of this instruction's params property.
setParams(String[]) - Method in class filenet.vw.api.VWRollbackInstruction
Initialize or modify the parameters of this instruction.
setParticipantName(String) - Method in class filenet.vw.api.VWParticipant
Sets the participant associated with the VWParticipant object.
setParticipants(VWParticipant[]) - Method in class filenet.vw.api.VWStepDefinition
Sets the participant's property value for the step.
setPostAssignments(String[][]) - Method in class filenet.vw.api.VWStepDefinition
Sets the PostAssignments property value for the step, which defines field values to be set after the step processes.
setPostMilestone(String) - Method in class filenet.vw.api.VWStepDefinition
Sets the value of this step's post-milestone property, which is the name of a milestone in this workflow which is "reached" just after this step finishes execution.
setPreAssignments(String[][]) - Method in class filenet.vw.api.VWStepDefinition
Sets the PreAssignments property value for the step, which defines field values to be set before the step processes.
setPreMilestone(String) - Method in class filenet.vw.api.VWStepDefinition
Sets the value of this step's pre-milestone property, which is the name of a milestone in this workflow which is "reached" just before this step begins execution.
setProcessorType(int) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Sets the processorType associated with this step processor's information.
setProductId(int) - Method in class filenet.vw.api.VWSession
Deprecated. Replaced by VWSession.setDefaultWebApplication(int)
setProxyUserName(String) - Method in class filenet.vw.api.VWUserInfo
Sets the proxy user name for this user information object. A proxy user receives work on behalf of the current user.
setQueueName(String) - Method in class filenet.vw.api.VWStepDefinition
Associates the named queue with the current step.
setReadSecurity(String[]) - Method in class filenet.vw.api.VWQueueDefinition
Sets Read access privilege for the queue.
setReadSecurity(String[]) - Method in class filenet.vw.api.VWRosterDefinition
Sets Read-only access for the roster.
setReDo(String) - Method in class filenet.vw.api.VWRollbackInstruction
Initialize or modify this rollback instruction's re-do expression.
setRelease(boolean) - Method in class filenet.vw.api.VWRouteDefinition
Sets the value of the release flag.
setReminder(long) - Method in class filenet.vw.api.VWStepDefinition
Sets the reminder value for the step.
setReminder(long) - Method in class filenet.vw.api.VWWorkflowDefinition
Changes the value of the reminder property for this workflow definition.
setRequestedInterface(String) - Method in class filenet.vw.api.VWStepDefinition
Requests an interface for the step (usually a step processor name associated with the top level UI).
setResponses(String[]) - Method in class filenet.vw.api.VWStepDefinition
Sets the responses to this step.
setRosterName(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Changes the value of the roster work class name for this workflow definition.
setRuleSets(int, VWRuleSetDefinition[]) - Method in class filenet.vw.api.VWMapNode
Sets the VWRuleSetDefinitions for this step definition.
setRuleSets(int, VWRuleSetDefinition[]) - Method in class filenet.vw.api.VWCompoundStepDefinition
Sets the VWRuleSetDefinitions for this compound step definition.
setSelectedResponse(String) - Method in class filenet.vw.api.VWStepElement
Sets a selected response for this step.
setSelectedResponse(String) - Method in class filenet.vw.api.VWWorkObject
Changes the selected (default) response for this work object.
setServerAssignment(int) - Method in class filenet.vw.api.VWUserInfo
Assigns a server ID for the current user.
setServerId(int) - Method in class filenet.vw.api.VWQueueDefinition
Sets the server ID for the queue.
setServerId(int) - Method in class filenet.vw.api.VWRosterDefinition
Sets the home server ID of the roster.
setSessionTimeOut(int) - Method in class filenet.vw.api.VWSystemAdministration
Sets the number of minutes used for all client / server sessions.
setSourceStepId(int) - Method in class filenet.vw.api.VWRouteDefinition
Sets the integer value of the stepId property for the step source.
setSplitType(int) - Method in class filenet.vw.api.VWMapNode
Changes the value of this step's SplitType property.
setStatisticsCollection(boolean) - Method in class filenet.vw.api.VWSystemConfiguration
Enables or disables the statistics gathering.
setStatisticsConsolidationInterval(int) - Method in class filenet.vw.api.VWSystemAdministration
Sets the number of minutes used for domain-wide statistics that are written the database.
setStatisticsSnapshotInterval(int) - Method in class filenet.vw.api.VWSystemAdministration
Deprecated. Not replaced
setSubject(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Modifies the value of the subject property of this workflow definition.
setSystemFlags(int) - Method in class filenet.vw.api.VWSystemAdministration
Sets the system-wide configuration flags; new settings take effect only after restarting the workflow services. Use VWSystemAdministration.commit() to save the flag settings to the workflow server.
setSystemWideFlags(int) - Method in class filenet.vw.api.VWSystemAdministration
Deprecated. Replaced by setSystemFlags, which requires VWSystemAdministration.commit() to save the flag values to the workflow server. This deprecated method saved the flag values automatically.
setTag(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Changes the value of the tag property of this workflow definition.
setTimeOut(String) - Method in class filenet.vw.api.VWWFEInstruction
Change the value of this instruction's timeOut expression property.
setType(int) - Method in class filenet.vw.api.VWAttachment
Sets the attachment type value for the associated attachment.
setValue(Object) - Method in class filenet.vw.api.VWParameter
Sets the value of this parameter, which is of one of the VWFieldType types.
setValue(Object) - Method in interface filenet.vw.api.IVWField
Set the value of the field unless it is a read-only or system field.
setValue(Object) - Method in class filenet.vw.api.VWDataField
Sets the value of data contained in an editable field.
Note If the field is an array, you can cast the array to an Object to pass it to this method.
setValue(Object) - Method in class filenet.vw.api.VWFieldDefinition
Modifies the value of the field, ensuring that the field type of this field definition matches the field type of the input value.
setValue(String) - Method in class filenet.vw.api.VWRuleSetDefinition
Sets the value for the rule set.
setValue(String) - Method in class filenet.vw.api.VWParameterDefinition
Modifies the parameter value.
setValue(String) - Method in class filenet.vw.api.VWEventDefinition
Changes the value of this event's value expression property.
setValue(String, int, boolean) - Method in class filenet.vw.api.VWFieldDefinition
Modifies the value of the data field with a String-formatted input to represent the value and an input field type. This method is especially useful for modifying a field value with an expression.
setVersion(String) - Method in class filenet.vw.api.VWAttachment
Sets the GUID for the attachment version for this attachment document.
setWidth(int) - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Sets the width associated with this step processor's information.
setWorkClassName(String) - Method in class filenet.vw.api.VWEventDefinition
Changes the value of this event's work class name property, which is the non-null name of the work class which contains this event.
setWriteSecurity(String[]) - Method in class filenet.vw.api.VWQueueDefinition
Sets Write access privileges for the current queue.
setWriteSecurity(String[]) - Method in class filenet.vw.api.VWRosterDefinition
Sets Write access for the roster.
SORT_TYPE_ASCENDING - Static variable in class filenet.vw.api.VWSession
Value of 1, indicating an ascending sort is to be performed.
SORT_TYPE_DESCENDING - Static variable in class filenet.vw.api.VWSession
Value of 2, indicating a descending sort is to be performed.
SORT_TYPE_NONE - Static variable in class filenet.vw.api.VWSession
Value of 0, indicating no sorting is to be performed.
SPLIT_TYPE_AND - Static variable in class filenet.vw.api.VWSplitType
Value of 1. Indicates a split where work will be routed, in parallel, over multiple paths which must all be traversed.
SPLIT_TYPE_NONE - Static variable in class filenet.vw.api.VWSplitType
Value of 3. Indicates there is no split at the step.
SPLIT_TYPE_OR - Static variable in class filenet.vw.api.VWSplitType
Value of 2. Indicates a branch where work will be routed to one among more than one paths.
startQuery(String, Object[], Object[], int, String, Object[]) - Method in class filenet.vw.api.VWRoster
Deprecated. Replaced by VWRoster.createQuery(String, Object[], Object[], int, String, Object[], int)
startQuery(String, Object[], Object[], int, String, Object[]) - Method in class filenet.vw.api.VWQueue
Deprecated. Replaced by VWQueue.createQuery( String, Object[], Object[], int, String, Object[], int).
Note Differences between the use of createQuery() and the deprecated startQuery() method include the following:

  • createQuery() uses a fetchType input parameter.
  • createQuery()'s resultant query object uses iterator methods VWQueueQuery.next() and VWQueueQuery.hasNext(), emulating the Collection Model in Java 2.
  • Warning You cannot use iterator methods next() or hasNext() on a VWQueueQuery object instantiated by the deprecated startQuery() method--the iterator methods throw an exception if you do.

startQuery(String, Object[], Object[], int, String, Object[]) - Method in class filenet.vw.api.VWLog
Fetches log items based on conditions specified in the parameters.
STATUS_COMPLETED - Static variable in class filenet.vw.api.VWStepWorkObjectHistory
 
STATUS_COMPLETED - Static variable in class filenet.vw.api.VWStepOccurrenceHistory
 
STATUS_COMPLETED_ABNORMAL - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_COMPLETED_NORMAL - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_DELEGATED - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_DELETED - Static variable in class filenet.vw.api.VWStepWorkObjectHistory
 
STATUS_DELETED - Static variable in class filenet.vw.api.VWStepOccurrenceHistory
 
STATUS_EXCEPTION - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_EXCEPTION - Static variable in class filenet.vw.api.VWStepWorkObjectHistory
 
STATUS_EXCEPTION - Static variable in class filenet.vw.api.VWStepOccurrenceHistory
 
STATUS_IN_PROGRESS - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_IN_PROGRESS - Static variable in class filenet.vw.api.VWStepWorkObjectHistory
 
STATUS_IN_PROGRESS - Static variable in class filenet.vw.api.VWStepOccurrenceHistory
 
STATUS_NULL - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_OVERDUE - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_REASSIGNED - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_REMINDED - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_RETURNED - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_WO_FORCED_TO_DELETE - Static variable in class filenet.vw.api.VWParticipantHistory
 
STATUS_WO_FORCED_TO_TERMINATE - Static variable in class filenet.vw.api.VWParticipantHistory
 
stringToValue(String, int, boolean) - Static method in class filenet.vw.api.VWFieldType
Returns an object or an array of objects of the specified type, as denoted by an input String.
success() - Method in class filenet.vw.api.VWCreateLiveWOResult
Determines whether a VWSession.createLiveWorkObject() method invocation was successful.
success() - Method in class filenet.vw.api.VWTransferResult
Determines whether a transfer was successful.
synchObject - Static variable in class filenet.vw.api.VWException
PropertyResourceBundle for the VWStrings file.
SYSTEM_WIDE_DELETE_PARENT - Static variable in class filenet.vw.api.VWSystemAdministration
Value of 4, indicating that the server should delete parent work objects when the children do not merge.
SYSTEM_WIDE_DISABLE_NOTIFICATION - Static variable in class filenet.vw.api.VWSystemAdministration
Value of 64, indicating that e-mail notification should be disabled on the server.
SYSTEM_WIDE_DISABLE_STATISTICS - Static variable in class filenet.vw.api.VWSystemAdministration
Value of 16, indicating that statistics should be disabled on the server.
SYSTEM_WIDE_DISABLE_TERMINATE - Static variable in class filenet.vw.api.VWSystemAdministration
Value of 32, indicating that logging of workflow termination events (F_EventType 165) should be disabled on the server.
SYSTEM_WIDE_FLAG_CONSISTENT_RETURN - Static variable in class filenet.vw.api.VWSystemAdministration
Value of 512, indicating that returns will be consistent with the behavior the return system instruction that is documented in the Help for Process Designer, Return system function topic.
SYSTEM_WIDE_FLAG_ENABLE_RULES - Static variable in class filenet.vw.api.VWSystemAdministration
Value of 1024, indicating that rules engine is enabled.
SYSTEM_WIDE_FLAG_NO_ANALYSIS_ENG - Static variable in class filenet.vw.api.VWSystemAdministration
Value of 256, indicating that the analysis engine should be disabled on the server.
SYSTEM_WIDE_LOOP_DETECTION - Static variable in class filenet.vw.api.VWSystemAdministration
Value of 1, indicating that the server should perform loop detection.
SYSTEM_WIDE_REMOVE_EXPIRED_TIMERS - Static variable in class filenet.vw.api.VWSystemAdministration
Value of 2, indicating that the server should remove expired timers from parent work objects.
SYSTEM_WIDE_UNDEFINED - Static variable in class filenet.vw.api.VWSystemAdministration
Value of 0, indicating the system-wide flag is undefined.

T

terminate() - Method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.doTerminate()
terminate() - Method in class filenet.vw.api.VWInstructionElement
Deprecated. Replaced by VWInstructionElement.doTerminate()
terminateMany(VWInstructionElement[]) - Static method in class filenet.vw.api.VWInstructionElement
Deprecated. Replaced by VWInstructionElement.doTerminateMany(VWInstructionElement[])
terminateMany(VWWorkObject[]) - Static method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.doTerminateMany( VWWorkObject[])
toString() - Method in class filenet.vw.api.VWValidationError
Gets a string that represents this VWValidationError instance.
toString() - Method in class filenet.vw.api.VWCreateLiveWOResult
Retrieves the string version of this transfer result object.
toString() - Method in class filenet.vw.api.VWInstructionDefinition
Gets a string representation of this object.
toString() - Method in class filenet.vw.api.VWSimpleInstruction
Gets a String representing this Instruction.
toString() - Method in class filenet.vw.api.VWQueueDefinition
Gets the string version of the queue definition.
toString() - Method in class filenet.vw.api.VWRuleSetDefinition
Gets the value of the rule set.
toString() - Method in class filenet.vw.api.VWStepElement
Gets the string version of the work item name.
toString() - Method in class filenet.vw.api.VWRosterQuery
Gets the name of the roster retrieved in a query.
toString() - Method in class filenet.vw.api.VWSystemAdministration
Gets a string representation of the VWSystemAdministration object.
toString() - Method in class filenet.vw.api.VWQueueQuery
Retrieves a string version of the current query's queue name.
toString() - Method in class filenet.vw.api.VWSession
Gets the router name and isolated region in String format, as entered by the user.
toString() - Method in class filenet.vw.api.VWIndexDefinition
Gets a string version of the VWIndexDefinition object.
toString() - Method in class filenet.vw.api.VWAttachment
Gets the String representation of a VWAttachment object associated with a document contained in library or object store The String contains seven elements; each element is delimited by the VWAttachment.SEPARATOR.
toString() - Method in class filenet.vw.api.VWRouteDefinition
Gets the string version of the object.
toString() - Method in class filenet.vw.api.VWQueueElement
Gets the workflow object name.
toString() - Method in class filenet.vw.api.VWWorkObject
Retrieves the string version of the work object name.
toString() - Method in class filenet.vw.api.VWRoster
Gets the roster name.
toString() - Method in class filenet.vw.api.VWMapNode
Gets a string representation of this map node object, typically used for debug echo statements.
toString() - Method in class filenet.vw.api.VWCompoundStepDefinition
Gets the name of this compound step definition object.
toString() - Method in class filenet.vw.api.VWMapDefinition
Gets the string version of the Workflow Map name.
toString() - Method in class filenet.vw.api.VWRosterElement
Gets a string version of a work object name.
toString() - Method in class filenet.vw.api.VWLogQuery
Gets the string version of the name of the log the query retrieved.
toString() - Method in class filenet.vw.api.VWException
Retrieves the associated string from the exceptions resource file.
toString() - Method in class filenet.vw.api.VWWFEInstruction
Gets the name of this rollback instruction
toString() - Method in class filenet.vw.api.VWParameterDefinition
Returns a string version of the name of the definition object associated with the parameter.
toString() - Method in class filenet.vw.api.VWInjectSessionInfo
Deprecated. Get the string version of the values of the sessionName, sessionStatus, and lastUpdateTime of the inject session.
toString() - Method in class filenet.vw.api.VWWorkflowRuntimeId
Returns the String representation of the workflow runtime id.
toString() - Method in class filenet.vw.api.VWParameter
Gets a string representation for the value of this parameter.
toString() - Method in class filenet.vw.api.VWQueue
Gets the string version of the queue name.
toString() - Method in class filenet.vw.api.VWRosterStats
Gets the work class name and the interval start and end times in a specific string format.
toString() - Method in class filenet.vw.api.VWLogElement
Gets a string version of the time stamp and sequence number for the record.
toString() - Method in class filenet.vw.api.VWLogDefinition
Returns the string representation of the log definition.
toString() - Method in class filenet.vw.api.VWStepDefinition
Gets the name of the step definition object.
toString() - Method in interface filenet.vw.api.IVWTableDefinition
Provides a string version of the table definition.
toString() - Method in class filenet.vw.api.VWInstructionElement
Provides a string version of the workflow object name.
toString() - Method in class filenet.vw.api.VWSystemConfiguration
Gets the String representation of the VWSystemConfiguration object.
toString() - Method in class filenet.vw.api.VWQueueStats
Gets the queue name and the start and end times of the statistics in a string format.
toString() - Method in class filenet.vw.api.VWNewWorkObject
Deprecated. Returns the string version of the new work object name.
toString() - Method in class filenet.vw.api.VWLog
Gets the string version of the log name.
toString() - Method in class filenet.vw.api.VWSecurityList
Gets the in-memory security list.
toString() - Method in class filenet.vw.api.VWDataField
Gets the data field value as a String.
toString() - Method in class filenet.vw.api.VWUserInfo
Gets the string version of the user name.
toString() - Method in class filenet.vw.api.VWFieldDefinition
Gets the name of the data field.
toString() - Method in class filenet.vw.api.VWRollbackInstruction
Gets the name of this rollback instruction.
toString() - Method in class filenet.vw.api.VWTransferResult
Retrieves the string version of this transfer result object.
toString() - Method in class filenet.vw.api.VWMilestoneElement
Gets a string version of the milestone, displaying several of its properties: ID, name, level, step, instruction sheet name, timestamp, and message.
toString() - Method in class filenet.vw.api.VWParticipant
Gets a string version of the participant name.
toString() - Method in class filenet.vw.api.VWStepProcessorInfoDefinition
Gets a string representation of the step processor object.
toString() - Method in class filenet.vw.api.VWWorkflowDefinition
Gets the String version of the workflow subject.
toString() - Method in class filenet.vw.api.VWRosterDefinition
Returns the string version of the roster definition.
toXML(StringBuffer) - Method in class filenet.vw.api.VWInstructionDefinition
Appends an XML string that represents this VWInstructionDefinition object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWSimpleInstruction
Appends an XML string that represents this VWSimpleInstruction object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWRuleSetDefinition
Appends an XML String that represents this VWRuleSetDefinition object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWStepElement
Appends an XML string that represents this VWStepElement object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWAttachment
Appends a description of this object's properties, formatted as an XML string, to the specified input buffer.
toXML(StringBuffer) - Method in class filenet.vw.api.VWMilestoneDefinition
Appends an XML string that represents this VWMilestoneDefinition object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWRouteDefinition
Appends an XML string that represents this VWRouteDefinition object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWQueueElement
Appends an XML string that represents this VWQueueElement object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWMapNode
Appends an XML string that represents this VWMapNode object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWCompoundStepDefinition
Appends an XML string that represents this VWCompoundStepDefinition object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWMapDefinition
Appends an XML string that represents this VWMapDefinition object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWRosterElement
Appends an XML string that represents this VWRosterElement object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWWFEInstruction
Appends an XML string that represents this VWWFEInstruction instance to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWStepProcessorInfo
Appends a description of this object's properties, formatted as an XML string, to the specified input buffer.
toXML(StringBuffer) - Method in class filenet.vw.api.VWParameterDefinition
Appends an XML string that represents this VWParameterDefinition object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWWorkflowRuntimeId
Appends a description of this object's properties to the specified input buffer, formatted as an XML string.
toXML(StringBuffer) - Method in class filenet.vw.api.VWParameter
Appends a description of this object's properties, formatted as an XML string, to the specified input buffer.
toXML(StringBuffer) - Method in class filenet.vw.api.VWEventDefinition
Appends an XML string that represents this VWEventDefinition object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWLogElement
Appends an XML string that represents this VWLogElement object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWStepDefinition
Appends an XML String that represents this VWStepDefinition object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in interface filenet.vw.api.IVWtoXML
Appends an XML string to the end of the buffer input on this method.
toXML(StringBuffer) - Method in class filenet.vw.api.VWDataField
Appends a description of this object's properties, formatted as an XML string, to the specified input buffer.
toXML(StringBuffer) - Method in class filenet.vw.api.VWFieldDefinition
Appends an XML string that represents this VWFieldDefinition object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWRollbackInstruction
Appends an XML string that represents this VWRollbackInstruction object to the buffer specified by the input parameter.
toXML(StringBuffer) - Method in class filenet.vw.api.VWMilestoneElement
Appends a description of this object's properties, formatted as an XML string, to the specified input buffer.
toXML(StringBuffer) - Method in class filenet.vw.api.VWWorkflowDefinition
Appends an XML String that represents this VWWorkflowDefinition object to the buffer specified by the input parameter.
transfer(VWWorkflowDefinition, String, boolean, boolean) - Method in class filenet.vw.api.VWSession
Transfers the workflow definition object, saving it on the Process Engine.The work class name saved on the Process Engine will be the name that is returned by the VWWorkflowDefinition.getName() method of of the input workflow definition.

U

unlock(boolean, boolean) - Method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.doSave(boolean)
unlock(boolean, boolean) - Method in class filenet.vw.api.VWInstructionElement
Deprecated. Replaced by VWInstructionElement.doUnlockMany(VWInstructionElement[], boolean, boolean)
unlockMany(VWInstructionElement[], boolean, boolean) - Static method in class filenet.vw.api.VWInstructionElement
Deprecated. Replaced by VWInstructionElement.doUnlockMany(VWInstructionElement[], boolean, boolean)
unlockMany(VWWorkObject[], boolean, boolean) - Static method in class filenet.vw.api.VWWorkObject
Deprecated. Replaced by VWWorkObject.doUnlockMany(VWWorkObject[], boolean, boolean)
UPDATE_RULESETS - Static variable in class filenet.vw.api.VWMapNode
Value of 1, for use with VWMapNode.getRuleSets(int) and VWMapNode.setRuleSets(int, VWRuleSetDefinition []).
updateAPIUserCache() - Method in class filenet.vw.api.VWSession
Caches user names for methods convertIdtoUserName, convertUserNametoId and getUserNames, for performance enhancement.
updateLogDefinition(VWLogDefinition) - Method in class filenet.vw.api.VWSystemConfiguration
Updates a log definition.
updateQueueDefinition(VWQueueDefinition) - Method in class filenet.vw.api.VWSystemConfiguration
Updates a queue definition.
updateRosterDefinition(VWRosterDefinition) - Method in class filenet.vw.api.VWSystemConfiguration
Updates a roster definition.

V

validate(Vector) - Method in class filenet.vw.api.VWRouteDefinition
Validates this VWRouteDefinition object, by appending any validation errors found to the specified Vector.
validate(Vector) - Method in class filenet.vw.api.VWParameterDefinition
Validates this VWParameterDefinition object.
validate(VWSession, boolean) - Method in class filenet.vw.api.VWWorkflowDefinition
Validates an instance of a VWWorkflowDefinition object.
validate(VWSession, Vector) - Method in class filenet.vw.api.VWRuleSetDefinition
Validates this VWRuleSetDefinition object, by updating the specified Vector with any validation errors found.
validate(VWSession, Vector) - Method in class filenet.vw.api.VWMilestoneDefinition
Validate this VWMilestoneDefinition object by testing that the message is an expression that conforms to workflow server grammar.
validate(VWSession, Vector) - Method in class filenet.vw.api.VWMapNode
Validates this object.
validate(VWSession, Vector) - Method in class filenet.vw.api.VWCompoundStepDefinition
Validates this VWCompoundStepDefinition object.
validate(VWSession, Vector) - Method in class filenet.vw.api.VWStepDefinition
Validate this VWStepDefinition object.
validate(VWSession, Vector) - Method in class filenet.vw.api.VWFieldDefinition
Updates the parameter EDefVector to contain any validation errors found in this session and VWFieldDefinition object.
validate(VWSession, Vector, VWCompoundStepDefinition) - Method in class filenet.vw.api.VWInstructionDefinition
Validate this object.
validate(VWSession, Vector, VWCompoundStepDefinition) - Method in class filenet.vw.api.VWSimpleInstruction
Validates this VWSimpleInstruction object.
validate(VWSession, Vector, VWCompoundStepDefinition) - Method in class filenet.vw.api.VWWFEInstruction
Validate this VWWFEInstruction object.
validate(VWSession, Vector, VWCompoundStepDefinition) - Method in class filenet.vw.api.VWRollbackInstruction
Validates the properties of this VWRollbackInstruction object.
validate(VWSession, VWWorkflowDefinition, Vector, VWCompoundStepDefinition, int, int) - Method in class filenet.vw.api.VWEventDefinition
Validate this VWEventDefinition object by appending VWValidationError objects to a vector.
VALIDATION_LEVEL_ERROR - Static variable in class filenet.vw.api.VWValidationError
Value of 1. A VWValidationError level value that indicates that a validation error WILL either cause transfer to fail or cause a problem at run-time.
VALIDATION_LEVEL_WARNING - Static variable in class filenet.vw.api.VWValidationError
Value of 2. A VWValidationError level value that indicates that a validation error MAY either cause transfer to fail or cause a problem at run-time.
VALIDATION_TYPE_FIELD - Static variable in class filenet.vw.api.VWValidationError
Integer value 4. Specifies that the validation item is a field.
VALIDATION_TYPE_INSTRUCTION - Static variable in class filenet.vw.api.VWValidationError
Integer value 7. Specifies that the validation item is a instruction.
VALIDATION_TYPE_MILESTONE - Static variable in class filenet.vw.api.VWValidationError
Integer value 8. Specifies that the validation item is a milestone.
VALIDATION_TYPE_PARAMETER - Static variable in class filenet.vw.api.VWValidationError
Integer value 3. Specifies that the validation item is a parameter.
VALIDATION_TYPE_ROUTE - Static variable in class filenet.vw.api.VWValidationError
Integer value 2. Specifies that the validation item is a route.
VALIDATION_TYPE_RULESET - Static variable in class filenet.vw.api.VWValidationError
Integer value 9. Specifies that the validation item is a ruleset.
VALIDATION_TYPE_STEP - Static variable in class filenet.vw.api.VWValidationError
Value of 1. Specifies that the validation item is a step.
VALIDATION_TYPE_WORKFLOW - Static variable in class filenet.vw.api.VWValidationError
Integer value 6. Specifies that the validation item is a workflow.
VARIABLE_PARAMS - Static variable in class filenet.vw.api.VWActionType
Value of 999. Flag value returned by VWActionType.numberOfParameters(int) to indicate that an action requires a variable number of parameters.
VWActionType - class filenet.vw.api.VWActionType.
This class defines constants to represent various actions that can be used in a compound step definition and accesses fundamental information about these actions.
VWActionType() - Constructor for class filenet.vw.api.VWActionType
 
VWAttachment - class filenet.vw.api.VWAttachment.
Use this class to access the identity, associated library or object store, type, Document ID, and version series of an attachment used in a workflow process.
VWAttachment() - Constructor for class filenet.vw.api.VWAttachment
Creates a VWAttachment object with empty values, initially.
VWAttachment(String) - Constructor for class filenet.vw.api.VWAttachment
Creates a VWAttachment object and sets the initial value.
VWAttachmentType - class filenet.vw.api.VWAttachmentType.
Use this class to access the type information for an attachment.
VWAttachmentType() - Constructor for class filenet.vw.api.VWAttachmentType
 
VWAttributeInfo - class filenet.vw.api.VWAttributeInfo.
VWAttributeInfo objects contain a set of name-value pairs; the VWAttributeInfo class enables users to associate properties they define with VWOperationDefinition, VWQueueDefinition, VWStepDefinition, VWSystemAdministration, VWSystemConfiguration, and VWWorkflowDefinition objects.
VWAttributeInfo() - Constructor for class filenet.vw.api.VWAttributeInfo
Constructor for creating a VWAttributeInfo Object.
VWCompoundStepDefinition - class filenet.vw.api.VWCompoundStepDefinition.
The VWCompoundStepDefinition class creates, deletes, and orders a series of workflow map nodes that execute various action types of workflow system instructions. Use the VWCompoundStepDefinition class to access timers, to make calls to sub-maps (instruction sheets), and to perform additional workflow map functions shown in the method summary.
VWCreateLiveWOResult - class filenet.vw.api.VWCreateLiveWOResult.
Use this class to access the return value of a VWSession.createLiveWorkObject() method call.
VWDataField - class filenet.vw.api.VWDataField.
Use this class to access a workflow object data field.
VWEventDefinition - class filenet.vw.api.VWEventDefinition.
The VWEventDefinition class encapsulates methods and data that define events. Events are used in the Wait For Event instructions (class VWWFEInstruction) of a compound step definition.
VWException - exception filenet.vw.api.VWException.
This is the base class for all workflow exceptions.
VWException(String, String) - Constructor for class filenet.vw.api.VWException
Constructor
VWException(String, String, Object) - Constructor for class filenet.vw.api.VWException
Constructor
VWException(String, String, Object[]) - Constructor for class filenet.vw.api.VWException
Constructor
VWException(String, String, Object, Object) - Constructor for class filenet.vw.api.VWException
Constructor
VWException(String, String, Object, Object, Object) - Constructor for class filenet.vw.api.VWException
Constructor
VWException(Throwable) - Constructor for class filenet.vw.api.VWException
Constructor
VWExposedFieldDefinition - class filenet.vw.api.VWExposedFieldDefinition.
Use this class to designate specific search fields for roster, queue, and log classes.
VWFetchType - class filenet.vw.api.VWFetchType.
Use this class to determine the fetch type and retrieve a string version of the type.
VWFetchType() - Constructor for class filenet.vw.api.VWFetchType
 
VWFieldDefinition - class filenet.vw.api.VWFieldDefinition.
Use this class to access a field definition object, which is the authoring-time representation of a field in a workflow.
VWFieldType - class filenet.vw.api.VWFieldType.
Use this class to determine the data field types available in a workflow.
VWFieldType() - Constructor for class filenet.vw.api.VWFieldType
 
VWIndexDefinition - class filenet.vw.api.VWIndexDefinition.
Use this class to define an index that contains concatenated field names--names which consist of the exposed or system fields. Arrays are not allowed.
VWInjectSessionInfo - class filenet.vw.api.VWInjectSessionInfo.
Deprecated. Replaced by VWSession.createLiveWorkObject(String[], Object[], String, int), which produces an instance of VWCreateLiveWOResult.
VWInstructionDefinition - class filenet.vw.api.VWInstructionDefinition.
This class represents an individual instruction within a compound step definition.
VWInstructionElement - class filenet.vw.api.VWInstructionElement.
Use this class to access the current operation on a workflow object, along with the operation parameters.
VWJoinType - class filenet.vw.api.VWJoinType.
Use this class to access the join type for branching of the workflow. The join type is a property of a step in a workflow graph which has multiple execution routes.
VWJoinType() - Constructor for class filenet.vw.api.VWJoinType
 
VWLibraryType - class filenet.vw.api.VWLibraryType.
Use this class to determine whether the library or Object Store type is Image Services, Content Services, or undefined.
VWLibraryType() - Constructor for class filenet.vw.api.VWLibraryType
 
VWLog - class filenet.vw.api.VWLog.
Use this class to query logs, determine the associated session, and access the log definition.
VWLogDefinition - class filenet.vw.api.VWLogDefinition.
VWLogDefinition administers properties of event log definitions for the default event log and roster event logs.
VWLogElement - class filenet.vw.api.VWLogElement.
Use this class to retrieve log element information.This class contains the information on the event log record.
VWLoggingOptionType - class filenet.vw.api.VWLoggingOptionType.
Use this class to set the option type for logging a message on the server.
VWLoggingOptionType() - Constructor for class filenet.vw.api.VWLoggingOptionType
 
VWLogQuery - class filenet.vw.api.VWLogQuery.
Use this class to query for log elements.
VWMapDefinition - class filenet.vw.api.VWMapDefinition.
Use this class to access workflow steps and properties of the Workflow Map.
VWMapNode - class filenet.vw.api.VWMapNode.
VWMapNode is an abstract base class which encapsulates the routing, location, and other properties that relate to the of steps of a map.
VWMergeType - class filenet.vw.api.VWMergeType.
Use this class to get the merge type for data fields.
VWMergeType() - Constructor for class filenet.vw.api.VWMergeType
 
VWMilestoneDefinition - class filenet.vw.api.VWMilestoneDefinition.
Use this class to access the name, message, level, and other properties of a milestone used in a workflow process.
VWMilestoneElement - class filenet.vw.api.VWMilestoneElement.
Use this class to encapsulate a milestone log record.
VWModeType - class filenet.vw.api.VWModeType.
Use this class to specify a directional attribute of an object such as, for example, a parameter of an operation or a step.
VWModeType() - Constructor for class filenet.vw.api.VWModeType
 
VWNewWorkObject - class filenet.vw.api.VWNewWorkObject.
Deprecated. Not Replaced
VWNodeType - class filenet.vw.api.VWNodeType.
Use this class to classify the nodes on a map into the following categories:
VWNodeType() - Constructor for class filenet.vw.api.VWNodeType
 
VWOperationDefinition - class filenet.vw.api.VWOperationDefinition.
A VWOperationDefinition object specifies an operation within a queue that performs a specific task. The definition includes the operation name, a set of parameters needed to perform the operation, and an optional description.
VWOperationType - class filenet.vw.api.VWOperationType.
Use this class to determine the operation type for a step.
VWOperationType() - Constructor for class filenet.vw.api.VWOperationType
 
VWParameter - class filenet.vw.api.VWParameter.
Use this class to access the parameter values for a step.
VWParameterDefinition - class filenet.vw.api.VWParameterDefinition.
Use this class to access the definition object for a parameter.
VWParticipant - class filenet.vw.api.VWParticipant.
A VWParticipant object represents a user or user group name.
VWParticipant() - Constructor for class filenet.vw.api.VWParticipant
Construct a participant object.
VWParticipant(String) - Constructor for class filenet.vw.api.VWParticipant
Construct a participant object and set the participant name property.
VWParticipantHistory - class filenet.vw.api.VWParticipantHistory.
Use this class to access the participant history for a step element.
VWProcess - class filenet.vw.api.VWProcess.
Use this class to access information about an executing workflow, such as status, history, or child/split work object information.
VWQueue - class filenet.vw.api.VWQueue.
Use this class to access the contents of a queue.
VWQueueDefinition - class filenet.vw.api.VWQueueDefinition.
Use this class to administer queue definitions.
VWQueueElement - class filenet.vw.api.VWQueueElement.
Accesses queue fields and Instruction Elements of a workflow object associated with a queue.
VWQueueQuery - class filenet.vw.api.VWQueueQuery.
Use this class to query for queue elements, work objects, or Instruction elements.
VWQueueStats - class filenet.vw.api.VWQueueStats.
Use this class to encapsulate the statistical results for a queue.
VWReturnStackElement - class filenet.vw.api.VWReturnStackElement.
Encapsulates a stack frame object for a work object, containing map and step identification and error description information.
VWRollbackInstruction - class filenet.vw.api.VWRollbackInstruction.
This class encapsulates rollback instructions for a compound step definition.
VWRoster - class filenet.vw.api.VWRoster.
Use this class to access the contents of a roster or manage running workflows.
VWRosterDefinition - class filenet.vw.api.VWRosterDefinition.
Use the VWRosterDefinition class to retrieve and administer roster definition information.
VWRosterElement - class filenet.vw.api.VWRosterElement.
Use this class to access a roster element and fetch a work object or an instruction element.
VWRosterQuery - class filenet.vw.api.VWRosterQuery.
Use this class to query roster elements or work objects.
VWRosterStats - class filenet.vw.api.VWRosterStats.
Use this class to retrieve roster statistics.
VWRouteDefinition - class filenet.vw.api.VWRouteDefinition.
Use this class to access an object that represents the workflow authoring-time definition of a route.
VWRuleSetDefinition - class filenet.vw.api.VWRuleSetDefinition.
This class encapsulates a ruleset object, which enables business rules to be independently applied to workflows.
VWSecurityList - class filenet.vw.api.VWSecurityList.
Use this class to query for a security list.
VWServerException - exception filenet.vw.api.VWServerException.
This is the base class for all workflow exceptions.
VWServerException(String, String, Long) - Constructor for class filenet.vw.api.VWServerException
Constructor
VWServerException(String, String, Long, Object) - Constructor for class filenet.vw.api.VWServerException
Constructor
VWServerException(String, String, Long, Object[]) - Constructor for class filenet.vw.api.VWServerException
Constructor
VWServerException(String, String, Long, Object, Object) - Constructor for class filenet.vw.api.VWServerException
Constructor
VWServerException(String, String, Long, Object, Object, Object) - Constructor for class filenet.vw.api.VWServerException
Constructor
VWSession - class filenet.vw.api.VWSession.
Use this class to establish a session and log onto a Process Engine.
VWSession() - Constructor for class filenet.vw.api.VWSession
Use this constructor with FileNet Web Services or Open Client.
VWSession(String, String, String) - Constructor for class filenet.vw.api.VWSession
Use this constructor to establish a session.
VWSimpleInstruction - class filenet.vw.api.VWSimpleInstruction.
The VWSimpleInstruction class encapsulates simple instructions in a compound step definition. In this implementation, every instruction except Rollback and WaitForEvent can be represented by a VWSimpleInstruction object.
VWSplitType - class filenet.vw.api.VWSplitType.
Use this class to access the split type for branching of the workflow. The split type is a property of a step in a workflow graph which has multiple execution routes.
VWSplitType() - Constructor for class filenet.vw.api.VWSplitType
 
VWStepDefinition - class filenet.vw.api.VWStepDefinition.
Use this class to access a step definition object: to create, delete, or modify step properties.
VWStepElement - class filenet.vw.api.VWStepElement.
Use this class to access a step in a workflow process.
VWStepHistory - class filenet.vw.api.VWStepHistory.
Use this class to query for a step history.
VWStepOccurrenceHistory - class filenet.vw.api.VWStepOccurrenceHistory.
Use this class to query the step occurrence history of work objects for a step.
VWStepProcessorInfo - class filenet.vw.api.VWStepProcessorInfo.
Use this class to access properties of the step processor object that are useful for launching a step, such as its dimensions, processor name and type, and Web application location.
VWStepProcessorInfo() - Constructor for class filenet.vw.api.VWStepProcessorInfo
Creates a VWStepProcessorInfo object with empty initial values.
VWStepProcessorInfoDefinition - class filenet.vw.api.VWStepProcessorInfoDefinition.
Use this class' methods to administer Step Processor information. Create this object with VWSystemConfiguration.createStepProcessorInfoDefinition().
VWStepProcessorInfoDefinition() - Constructor for class filenet.vw.api.VWStepProcessorInfoDefinition
Creates a minimal VWStepProcessorInfoDefinition object.
VWStepProcessorInfoDefinition(int, int, String, int, Hashtable, int, int, String) - Constructor for class filenet.vw.api.VWStepProcessorInfoDefinition
Creates a VWStepProcessorInfoDefinition object using input arguments, including a hashtable of the locations associated with this step processor, for each web application.
VWStepProcessorInfoDefinition(int, int, String, int, String, int, int, String) - Constructor for class filenet.vw.api.VWStepProcessorInfoDefinition
Deprecated. Replaced by VWStepProcessorInfoDefinition.VWStepProcessorInfoDefinition(int, int, String, int, Hashtable, int, int, String), which inputs a hashtable of the locations associated with this step processor, for each web application.
VWStepWorkObjectHistory - class filenet.vw.api.VWStepWorkObjectHistory.
Use this class to query the participant histories of a step occurrence history item.
VWSystemAdministration - class filenet.vw.api.VWSystemAdministration.
Use this class to access and modify system-wide administration information or tasks.
VWSystemConfiguration - class filenet.vw.api.VWSystemConfiguration.
Use this class to access configuration information for an isolated region.
VWTimeUnitType - class filenet.vw.api.VWTimeUnitType.
Use this class to define the time unit types used in computing statistical results.
VWTimeUnitType() - Constructor for class filenet.vw.api.VWTimeUnitType
 
VWTransferResult - class filenet.vw.api.VWTransferResult.
Use this class to access the value returned by a VWSession.transfer() method call.
VWUserInfo - class filenet.vw.api.VWUserInfo.
Use this class to access information for a specific user.
VWValidationError - class filenet.vw.api.VWValidationError.
Use this class to access information about errors encountered during the workflow definition validation process.
VWWFEInstruction - class filenet.vw.api.VWWFEInstruction.
This class encapsulates wait for event instructions in a compound step definition.
VWWorkflowDefinition - class filenet.vw.api.VWWorkflowDefinition.
Use this class to create, delete, and access a workflow definition object and its sub-objects.
VWWorkflowDefinition() - Constructor for class filenet.vw.api.VWWorkflowDefinition
Public constructor for the VWWorkflowDefinition class.
VWWorkflowHistory - class filenet.vw.api.VWWorkflowHistory.
Use this class to query step history information.
VWWorkflowMilestones - class filenet.vw.api.VWWorkflowMilestones.
Queries for workflow milestone occurrences in the workflow log.
VWWorkflowRuntimeId - class filenet.vw.api.VWWorkflowRuntimeId.
This class designates a workflow runtime ID for a workflow definition that has been transferred and compiled.
VWWorkflowSignature - class filenet.vw.api.VWWorkflowSignature.
This class designates a workflow signature after it is transferred and compiled, but before it becomes an executing workflow process.
VWWorkObject - class filenet.vw.api.VWWorkObject.
Use this class to access all data fields in a work object and fetch Instruction Element information associated with the work object.
VWXMLUtil - class filenet.vw.api.VWXMLUtil.
VWXMLUtil creates and processes blocks of XML.
VWXMLUtil() - Constructor for class filenet.vw.api.VWXMLUtil
 

W

WEBAPP_CUSTOM - Static variable in class filenet.vw.api.VWSession
Value of 100. Indicates the web application is for custom use.
WEBAPP_NONE - Static variable in class filenet.vw.api.VWSession
Value of 0. Indicates the web application is not set.
WEBAPP_OPEN_CLIENT - Static variable in class filenet.vw.api.VWSession
Value of 3. Indicates the web application is Open Client.
WEBAPP_WEB_WORKFLO - Static variable in class filenet.vw.api.VWSession
Value of 2. Indicates the web application is FileNet Web Services.
WEBAPP_WORKPLACE - Static variable in class filenet.vw.api.VWSession
Value of 1. Indicates the web application is Application Engine.
WEEKS - Static variable in class filenet.vw.api.VWTimeUnitType
Value of 4. Specifies weeks as the time unit.
write(OutputStream) - Method in class filenet.vw.api.VWWorkflowDefinition
Writes this VWWorkflowDefinition object to an output stream.
writeToFile(String) - Method in class filenet.vw.api.VWWorkflowDefinition
Writes this VWWorkflowDefinition object to a file.

Y

YEARS - Static variable in class filenet.vw.api.VWTimeUnitType
Value of 6. Specifies years as the time unit.

A B C D F G H I J L M N O P Q R S T U V W Y

Copyright © 2002, 2003 FileNet Corporation. All rights reserved.