|
Process API | ||||||||
PREV NEXT | FRAMES NO FRAMES |
Uses of VWException in filenet.vw.api |
---|
Subclasses of VWException in filenet.vw.api | |
---|---|
class |
VWServerException
This is the base class for all workflow exceptions. |
Methods in filenet.vw.api that return VWException | |
---|---|
static VWException[] |
VWWorkObject.doDeleteMany(VWWorkObject[] elements,
boolean overrideLock,
boolean force)
Deletes the specified work objects. |
static VWException[] |
VWInstructionElement.doLockMany(VWInstructionElement[] intrs,
boolean overrideLock)
Deprecated. Locks Instruction Elements associated with workflow objects in a single call. |
static VWException[] |
VWWorkObject.doLockMany(VWWorkObject[] wobjs,
boolean overrideLock)
Locks multiple work objects in a single call and refreshes them with current information. |
static VWException[] |
VWInstructionElement.doSaveMany(VWInstructionElement[] invs)
Deprecated. Saves and updates information for each workflow object specified by the passed array of Instruction Elements. |
static VWException[] |
VWWorkObject.doSaveMany(VWWorkObject[] workObjects)
Saves information for an array of work objects. |
static VWException[] |
VWInstructionElement.doTerminateMany(VWInstructionElement[] elements)
Deprecated. Terminates workflow objects associated with the passed Instruction Elements. |
static VWException[] |
VWWorkObject.doTerminateMany(VWWorkObject[] elements)
Terminates the specified work objects. |
static VWException[] |
VWInstructionElement.doUnlockMany(VWInstructionElement[] invs,
boolean save,
boolean dispatch)
Deprecated. Unlocks the array of workflow objects specified by the passed Instruction Elements. |
static VWException[] |
VWStepElement.doUnlockMany(VWStepElement[] stepElements,
boolean save,
boolean dispatch)
Unlocks an array of step elements. |
static VWException[] |
VWWorkObject.doUnlockMany(VWWorkObject[] workObjects,
boolean save,
boolean dispatch)
Unlocks an array of work objects. |
static VWException[] |
VWInstructionElement.lockMany(VWInstructionElement[] intrs,
boolean overrideLock)
Deprecated. Replaced by VWInstructionElement.doLockMany(VWInstructionElement[], boolean) |
static VWException[] |
VWWorkObject.lockMany(VWWorkObject[] wobjs,
boolean overrideLock)
Deprecated. Replaced by VWWorkObject.doLockMany(VWWorkObject[], boolean) |
static VWException[] |
VWInstructionElement.saveMany(VWInstructionElement[] invs)
Deprecated. Replaced by VWInstructionElement.doSaveMany(VWInstructionElement[]) |
static VWException[] |
VWWorkObject.saveMany(VWWorkObject[] workObjects)
Deprecated. Replaced by VWWorkObject.doSaveMany(VWWorkObject[]) |
static VWException[] |
VWInstructionElement.terminateMany(VWInstructionElement[] elements)
Deprecated. Replaced by VWInstructionElement.doTerminateMany(VWInstructionElement[]) |
static VWException[] |
VWWorkObject.terminateMany(VWWorkObject[] elements)
Deprecated. Replaced by VWWorkObject.doTerminateMany( VWWorkObject[]) |
static VWException[] |
VWInstructionElement.unlockMany(VWInstructionElement[] invs,
boolean save,
boolean dispatch)
Deprecated. Replaced by VWInstructionElement.doUnlockMany(VWInstructionElement[], boolean, boolean) |
static VWException[] |
VWWorkObject.unlockMany(VWWorkObject[] workObjects,
boolean save,
boolean dispatch)
Deprecated. Replaced by VWWorkObject.doUnlockMany(VWWorkObject[], boolean, boolean) |
Methods in filenet.vw.api that throw VWException | |
---|---|
void |
VWWorkflowCollectionDefinition.addWorkflow(VWWorkflowDefinition theWorkflow)
Adds a workflow to this collection. |
java.lang.String |
VWWorkflowDefinition.AsXMLString()
Retrieves an XML-formatted representation of this workflow definition. |
java.lang.String |
VWStepPaletteDefinition.AsXMLString()
Retrieves an XML formatted representation of this step palette. |
java.lang.String |
VWWorkflowCollectionDefinition.asXPDLString()
Retrieves an XPDL formatted representation of this instance. |
VWMapNode |
VWMapDefinition.changeStepType(int theStepId)
Replaces in this map either a step (VWStepDefinition) with a compound step (VWCompoundStepDefinition), or a compound step with a step. |
boolean |
VWSession.checkSystemWideFlagSetting(int flagOptions)
Checks the system wide flag settings given the VWSystemAdministration System wide flag option. |
boolean |
VWSession.checkWorkflowIdentifier(java.lang.String workflowIdentifier)
Indicates whether or not a workflow is on the Process Engine, based on the specified workflow version ID. |
java.lang.String[] |
VWSystemConfiguration.commit()
Saves system configuration changes to the current isolated region. |
void |
VWSystemAdministration.commit()
Saves system administration changes to the system-wide configuration on the workflow server. |
void |
VWWorkflowDefinition.convertAllRouteConditionsToValidExpressions()
Converts the route conditions for each route in this workflow definition to the standard syntax format: Expressions containing "ALL", "NONE", "ANY" or "COUNT" are converted to expressions using the F_Responses and F_ResponseCount fields. |
int |
VWSession.convertClassNameToId(java.lang.String aClassName,
boolean aQueueClassType)
Converts a roster or queue name to a class ID. |
VWParticipant[] |
VWSession.convertIdsToUserNamesPx(long[] userIds)
Converts a list of user IDs to the associated user names (contained in a VWParticipant array). |
java.lang.String |
VWSession.convertIdToClassName(int aClassId,
boolean aQueueClassType)
Converts a class ID to a roster or queue name. |
java.lang.String |
VWSession.convertIdToUserName(int aUserId)
Converts a user ID to a user name. |
VWParticipant |
VWSession.convertIdToUserNamePx(long userId)
Converts a single user ID to the associated user name (contained in a VWParticipant array). |
int |
VWWorkflowSignature.convertInstructionSheetNameToId(java.lang.String strISheetName)
Converts an instruction sheet name to an instruction sheet ID. |
java.lang.String |
VWQueue.convertOperationIdToName(int theOperationId)
Converts an operation ID to a name, using the name/ID pair in the current workspace. |
int |
VWQueue.convertOperationNameToId(java.lang.String theOperationName)
Converts an operation name to an ID, using the name/ID pair in the current workspace. |
int |
VWSession.convertUserNameToId(java.lang.String aUserName)
Converts a user name in three-part format (name:domain:organization) to a user ID. |
VWApplicationSpaceDefinition |
VWSystemConfiguration.createApplicationSpaceDefinition(java.lang.String name)
Creates an application space definition. |
VWInstructionDefinition |
VWCompoundStepDefinition.createAssignInstruction(java.lang.String[][] assignPairs)
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. |
VWAssociationDefinition |
VWTextAnnotationDefinition.createAssociation(int targetId,
int targetType)
Creates, in the map that contains this annotation, an assocation from this text annotation to a map node (step) or route. |
VWAttachmentTrackingQuery |
VWSession.createAttachmentTrackingQuery(VWAttachment anAttachment)
Creates a VWAttachmentTrackingQuery object that describes which running/active workflows are currently referencing a particular attachment. |
VWInstructionDefinition |
VWCompoundStepDefinition.createBeginCheckPointInstruction()
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. |
VWInstructionDefinition |
VWCompoundStepDefinition.createBeginTimerInstruction(java.lang.String theTimerName,
java.lang.String theExpirationTime,
java.lang.String theISName,
java.lang.String thePreemptiveExpirationExpr)
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. |
VWInstructionDefinition |
VWCompoundStepDefinition.createCallInstruction(java.lang.String theMapName)
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. |
VWCompoundStepDefinition |
VWStepPaletteDefinition.createCompoundStep(java.lang.String theStepName)
Creates a compound step on the step palette. |
VWCompoundStepDefinition |
VWMapDefinition.createCompoundStep(java.lang.String theStepName)
Creates a compound step in this workflow map. |
VWRoleDefinition |
VWApplicationSpaceDefinition.createCopyOfRoleDefinition(java.lang.String roleName,
VWRoleDefinition origRoleDef)
Creates a new role definition using the data from the specified role definition. |
VWWorkBasketDefinition |
VWQueueDefinition.createCopyOfWorkBasketDefinition(java.lang.String workBasketName,
VWWorkBasketDefinition origWorkBasketDef)
Creates a new work basket definition using the data from the specified workbasket definition. |
VWWorkBasketFilterDefinition |
VWWorkBasketDefinition.createCopyOfWorkBasketFilterDefinition(java.lang.String workBasketFilterName,
VWWorkBasketFilterDefinition origWorkBasketFilterDef)
Creates a new work basket filter definition using the data from the specified work basket filter definition. |
VWInstructionDefinition |
VWCompoundStepDefinition.createCreateInstruction(java.lang.String theWorkClassName,
java.lang.String[][] theFieldAssignList)
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. |
VWInstructionDefinition |
VWCompoundStepDefinition.createDatabaseExecuteInstruction(java.lang.String theDatabaseName,
java.lang.String theProcedureName,
java.lang.String[] theParamList)
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. |
VWInstructionDefinition |
VWCompoundStepDefinition.createDelayInstruction(java.lang.String delay)
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. |
VWInstructionDefinition |
VWCompoundStepDefinition.createEndAllTimersInstruction()
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. |
VWInstructionDefinition |
VWCompoundStepDefinition.createEndCheckPointInstruction()
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. |
VWInstructionDefinition |
VWCompoundStepDefinition.createEndTimerInstruction(java.lang.String theTimer)
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. |
VWEventDefinition |
VWWFEInstruction.createEvent(java.lang.String theWCName,
java.lang.String theOperator,
java.lang.String theValue)
Creates an event in this VWWFEInstruction instance. |
VWInstructionDefinition |
VWCompoundStepDefinition.createExecuteInstruction(java.lang.String theQueueName,
java.lang.String theOperationName,
java.lang.String[] theParamList)
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. |
VWFaultDefinition |
VWInvokeInstruction.createFault(java.lang.String theName,
java.lang.String theFaultMessage,
java.lang.String theFaultMapName)
Creates a fault in this instance. |
VWExposedFieldDefinition |
VWTableDefinition.createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Create an exposed field by input of a field name and data type. |
VWExposedFieldDefinition |
VWRosterDefinition.createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Creates an exposed field on the roster, based on the supplied field name and type. |
VWExposedFieldDefinition |
VWQueueDefinition.createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Creates an exposed field in the queue, based on the specified field name and type. |
VWExposedFieldDefinition |
VWLogDefinition.createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Creates an exposed field on this log from the supplied field name and type. |
VWExposedFieldDefinition |
IVWTableDefinition.createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Creates an exposed field by passing in a field name and the type. |
void |
VWRosterDefinition.createFieldDefinitions(VWExposedFieldDefinition[] theDefs)
Creates the complete field definition for this roster. |
void |
VWQueueDefinition.createFieldDefinitions(VWExposedFieldDefinition[] theDefs)
Creates all of the exposed field definitions for this queue. |
VWFieldDefinition |
VWWorkflowDefinition.createFieldUsingObject(java.lang.String theName,
java.lang.Object theValue)
Deprecated. Replaced by VWWorkflowDefinition.createFieldUsingString(String, String, int, boolean) |
VWFieldDefinition |
VWWorkflowDefinition.createFieldUsingString(java.lang.String theName,
java.lang.String theValueString,
int theType,
boolean theIsArray)
Creates a data field in this workflow definition, with values initialized by a field. |
VWWebServiceParameterDefinition |
VWInvokeInstruction.createInComingParameter(java.lang.String theName,
java.lang.String theValue,
int theType,
boolean theIsArray)
Creates an incoming parameter with name, direction, value, and type information. |
VWIndexDefinition |
VWTableDefinition.createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Create the index definition DMM addded because of IVWTableDef |
VWIndexDefinition |
VWRosterDefinition.createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Creates an index definition for the roster. |
VWIndexDefinition |
VWQueueDefinition.createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Creates an index definition for this queue. |
VWIndexDefinition |
VWLogDefinition.createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Creates an index definition for the specified log. |
VWIndexDefinition |
IVWTableDefinition.createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Creates an index definition for this queue. |
void |
VWRosterDefinition.createIndexDefinitions(VWIndexDefinition[] theDefs)
Creates the complete index definition for this roster. |
void |
VWQueueDefinition.createIndexDefinitions(VWIndexDefinition[] theDefs)
Creates all of the index definitions for this queue. |
VWInstructionDefinition |
VWCompoundStepDefinition.createInvokeInstruction(java.lang.String thePartnerLinkName,
java.lang.String theOperationName)
Creates an invoke instruction in this compound step definition by assigning it a new instruction Id and appending it to this compound step's instruction list. |
VWCreateLiveWOResult[] |
VWSession.createLiveWorkObject(java.lang.String[] fieldNames,
java.lang.Object[] fieldValues,
java.lang.String workflowIdentifier,
int numberToCreate)
Creates (initializes, saves, and dispatches) work items from a transferred workflow definition, specified by its workflow identifier. |
VWLogDefinition |
VWSystemConfiguration.createLogDefinition(java.lang.String theName)
Creates a log definition. |
VWInstructionDefinition |
VWCompoundStepDefinition.createLogInstruction(java.lang.String theEventType,
java.lang.String theEventText)
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. |
javax.mail.Session |
VWSession.createMailSession()
Creates a java mail session based on email notification configuration information specified on a Process Engine server. |
VWMapDefinition |
VWWorkflowDefinition.createMap(java.lang.String theName)
Creates a new map in this workflow definition. |
VWMilestoneDefinition |
VWWorkflowDefinition.createMilestone(java.lang.String theName)
Creates a new milestone in this workflow definition. |
VWInstructionDefinition |
VWCompoundStepDefinition.createNoOpInstruction()
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. |
VWOperationDefinition |
VWQueueDefinition.createOperation(java.lang.String theName)
Creates an operation definition in this queue. |
VWWebServiceParameterDefinition |
VWInvokeInstruction.createOutGoingParameter(java.lang.String theName,
java.lang.String theValue,
int theType,
boolean theIsArray)
Creates an outgoing parameter with name, direction, value, and type information. |
VWParameterDefinition |
VWStepDefinition.createParameter(java.lang.String theName,
int theMode,
java.lang.String theValue,
int theType,
boolean theIsArray)
Creates a parameter with name, direction, value, and type information. |
VWWebServiceParameterDefinition |
VWReplyInstruction.createParameter(java.lang.String theName,
java.lang.String theValue,
int theType,
boolean theIsArray)
Creates a parameter with name, direction, value, and type information. |
VWWebServiceParameterDefinition |
VWReceiveInstruction.createParameter(java.lang.String theName,
java.lang.String theValue,
int theType,
boolean theIsArray)
Creates a parameter with name, direction, value, and type information. |
VWPartnerLinkDefinition |
VWWorkflowDefinition.createPartnerLink(java.lang.String theName)
Creates a new partner link in this workflow definition. |
VWRosterQuery |
VWRoster.createQuery(java.lang.String indexName,
java.lang.Object[] minValues,
java.lang.Object[] maxValues,
int queryFlags,
java.lang.String filter,
java.lang.Object[] substitutionVars,
int fetchType)
Performs a filtered fetch of roster items. |
VWQueueQuery |
VWQueue.createQuery(java.lang.String indexName,
java.lang.Object[] minValues,
java.lang.Object[] maxValues,
int queryFlags,
java.lang.String filter,
java.lang.Object[] substitutionVars,
int fetchType)
Performs a filtered fetch of queue items. |
VWQueueDefinition |
VWSystemConfiguration.createQueueDefinition(java.lang.String theName,
int theQueueType)
Creates a queue definition. |
VWInstructionDefinition |
VWCompoundStepDefinition.createReceiveInstruction(java.lang.String thePartnerLinkName,
java.lang.String theOperationName)
Creates an receive instruction in this compound step definition by assigning it a new instruction Id and appending it to this compound step's instruction list. |
VWInstructionDefinition |
VWCompoundStepDefinition.createReplyInstruction(java.lang.String thePartnerLinkName,
java.lang.String theOperationName)
Creates a reply instruction in this compound step definition by assigning it a new instruction Id and appending it to this compound step's instruction list. |
VWInstructionDefinition |
VWCompoundStepDefinition.createResumeTimerInstruction(java.lang.String theTimer)
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. |
VWInstructionDefinition |
VWCompoundStepDefinition.createReturnInstruction(java.lang.String retryOption)
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. |
VWRoleDefinition |
VWApplicationSpaceDefinition.createRoleDefinition(java.lang.String roleName)
Creates a new role definition. |
VWInstructionDefinition |
VWCompoundStepDefinition.createRollbackCheckpointInstruction(java.lang.String theReDoFlag,
java.lang.String theCompCallIS,
java.lang.String[] theNonRollbackFieldList)
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. |
VWRosterDefinition |
VWSystemConfiguration.createRosterDefinition(java.lang.String theName)
Creates a roster definition. |
VWRouteDefinition |
VWMapNode.createRoute(int theDestinationId)
Creates an outbound route for the current step. |
VWRuleSetDefinition |
VWWorkflowDefinition.createRuleSet(java.lang.String theValue)
Creates a new rule set (VWRuleSetDefinition object) in this workflow. |
VWSchema |
VWWorkflowDefinition.createSchema(java.lang.String theName)
Creates a new schema in this workflow definition. |
VWStepDefinition |
VWStepPaletteDefinition.createStep(java.lang.String theStepName)
Creates a step on the step palette. |
VWStepDefinition |
VWMapDefinition.createStep(java.lang.String theStepName)
Creates a step in this workflow map. |
VWStepProcessorInfoDefinition |
VWSystemConfiguration.createStepProcessorInfoDefinition()
Creates a step processor definition. |
VWInstructionDefinition |
VWCompoundStepDefinition.createSuspendTimerInstruction(java.lang.String timer)
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. |
VWInstructionDefinition |
VWCompoundStepDefinition.createTerminateBranchInstruction()
Creates a terminate branch instruction in this compound step definition, assigning it a new instruction ID, and appending it to the instruction list for this compound step. |
VWInstructionDefinition |
VWCompoundStepDefinition.createTerminateInstruction()
Deprecated. Use createTerminateBranchInstruction() instead. The old terminate instruction was renamed terminateBranch to distinguish it from the newer terminateProcess instruction. This method will create a terminateBranch instruction. |
VWInstructionDefinition |
VWCompoundStepDefinition.createTerminateProcessInstruction()
Creates a terminate process instruction in this compound step definition, assigning it a new instruction ID, and appending it to the instruction list for this compound step. |
VWTextAnnotationDefinition |
VWMapDefinition.createTextAnnotation(java.lang.String theMessage)
Creates a new annotation for this map. |
VWUserInfo |
VWSystemAdministration.createUserInfo()
Deprecated. VWUserInfo records are created on the server in P8PE4.0 |
VWInstructionDefinition |
VWCompoundStepDefinition.createWFEInstruction(java.lang.String theTimeOut,
java.lang.String theEventNumLocation)
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. |
VWWorkBasketColumnDefinition |
VWWorkBasketDefinition.createWorkBasketColumnDefinition(java.lang.String prompt,
VWExposedFieldDefinition column)
Create a new work basket column definition. |
VWWorkBasketDefinition |
VWQueueDefinition.createWorkBasketDefinition(java.lang.String workBasketName)
Creates a new workbasket definition. |
VWWorkBasketFilterDefinition |
VWWorkBasketDefinition.createWorkBasketFilterDefinition(java.lang.String workBasketFilterName)
Creates a new work basket filter definition. |
VWStepElement |
VWSession.createWorkflow(java.lang.String workflowIdentifier)
Launches a workflow defined by a transferred workflow definition, as specified by the workflow version or the workflow definition name (work class name). |
void |
VWProcess.delete()
Deletes all work objects of a running workflow process. |
void |
VWTextAnnotationDefinition.deleteAllAssociations()
Delete all associations from this text annotation. |
void |
VWInvokeInstruction.deleteAllInComingParameters()
Deletes all incoming parameter definitions for this instance. |
void |
VWInvokeInstruction.deleteAllOutGoingParameters()
Deletes all outgoing parameter definitions for this instance. |
void |
VWReplyInstruction.deleteAllParameters()
Deletes all parameter definitions for this reply instruction. |
void |
VWReceiveInstruction.deleteAllParameters()
Deletes all parameter definitions for this receive instruction. |
void |
VWInvokeInstruction.deleteAllParameters()
Deletes all incoming and outgoing parameter definitions for this instance. |
void |
VWTextAnnotationDefinition.deleteAssociation(int targetId,
int targetType)
Deletes a specified assocation from this text annotation. |
void |
VWWorkflowDefinition.deleteField(java.lang.String theName)
Deletes a field definition from the workflow definition. |
void |
VWUserInfo.deleteField(java.lang.String fieldName)
Deletes the named field entry. |
void |
VWAttributeInfo.deleteField(java.lang.String fieldName)
Deletes a field entry, specified by name. |
void |
VWTableDefinition.deleteFieldDefinition(java.lang.String theName)
Delete an exposed field from one of the following: log, queue, or roster. |
void |
VWRosterDefinition.deleteFieldDefinition(java.lang.String theName)
Deletes an exposed field from the roster. |
void |
VWQueueDefinition.deleteFieldDefinition(java.lang.String theName)
Removes the specified exposed field from this queue. |
void |
VWLogDefinition.deleteFieldDefinition(java.lang.String theName)
Deletes an exposed field from the log. |
void |
IVWTableDefinition.deleteFieldDefinition(java.lang.String theName)
Provides the ability to delete exposed fields from the queue. |
void |
VWInvokeInstruction.deleteInComingParameter(int theSequenceNumber)
Deletes a parameter definition from the set of incoming parameter definitions stored in this instance. |
void |
VWTableDefinition.deleteIndexDefinition(java.lang.String theName)
Delete an index from one of the following: log, queue, or roster. |
void |
VWRosterDefinition.deleteIndexDefinition(java.lang.String theName)
Deletes an index from this roster. |
void |
VWQueueDefinition.deleteIndexDefinition(java.lang.String theName)
Removes the specified index from this queue. |
void |
VWLogDefinition.deleteIndexDefinition(java.lang.String theName)
Deletes an index from the log. |
void |
IVWTableDefinition.deleteIndexDefinition(java.lang.String theName)
Provides the ability to delete indexes from this queue. |
void |
VWCompoundStepDefinition.deleteInstruction(int theInstructionId)
Deletes an instruction from this compound step definition, specified by the instruction id. |
void |
VWWorkflowDefinition.deleteMap(int theMapId)
Deprecated. Replaced by VWWorkflowDefinition.deleteMap(String) |
void |
VWWorkflowDefinition.deleteMap(java.lang.String theMapName)
Deletes the specified map from this workflow definition. |
void |
VWWorkflowDefinition.deleteMilestone(java.lang.String theName)
Deletes the specified milestone from this workflow definition. |
void |
VWQueueDefinition.deleteOperation(java.lang.String theName)
Removes the specified operation from this queue. |
void |
VWInvokeInstruction.deleteOutGoingParameter(int theSequenceNumber)
Deletes a parameter definition from the set of outgoing parameter definitions stored in this instance. |
void |
VWReplyInstruction.deleteParameter(int theSequenceNumber)
Deletes a parameter definition from the set of parameter definitions stored in this reply instruction. |
void |
VWReceiveInstruction.deleteParameter(int theSequenceNumber)
Deletes a parameter definition from the set of parameter definitions stored in this receive instruction. |
void |
VWStepDefinition.deleteParameter(java.lang.String theName)
Deletes a parameter definition from the set of parameter definitions stored in this step. |
void |
VWWorkflowDefinition.deletePartnerLink(java.lang.String theName)
Deletes the specified partner link from this workflow definition. |
VWRoleDefinition |
VWApplicationSpaceDefinition.deleteRoleDefinition(java.lang.String roleName)
Deletes the specified role definition. |
void |
VWMapNode.deleteRoute(int theRouteId)
Deletes an outbound route from this step. |
void |
VWWorkflowDefinition.deleteRuleSet(java.lang.String theRuleSetName)
Deletes the specified rule set definition from this instance, removing all references to the rule set from the workflow definition steps. |
void |
VWWorkflowDefinition.deleteRuleSet(VWRuleSetDefinition theRuleSet)
Deprecated. Use public void deleteRuleSet(String theRuleSetName) instead. Changes in the API to support inheriting rulessets make it is no longer possible to support deleting rulesets by reference. Rulesets should be deleted by name. This method calls deleteRuleSet(theRuleSet.getName()). |
void |
VWWorkflowDefinition.deleteSchema(java.lang.String theName)
Deletes the specified schema from this workflow definition. |
void |
VWStepPaletteDefinition.deleteStep(int theStepId)
Deletes the specified step from this step palette. |
void |
VWMapDefinition.deleteStep(int theStepId)
Deletes a step from the workflow map. |
void |
VWStepPaletteDefinition.deleteStep(java.lang.String theStepName)
Deprecated. Replaced by VWStepPaletteDefinition.deleteStep(int) |
void |
VWSystemConfiguration.deleteStepProcessorInfoDefinition(VWStepProcessorInfoDefinition theSPDef)
Deletes a step processor info definition. |
void |
VWMapDefinition.deleteTextAnnotation(int theAnnotationId)
Deletes an annotation from this map. |
void |
VWSystemAdministration.deleteUserInfo(java.lang.String theUserName)
Deletes information about a specified user. |
VWWorkBasketColumnDefinition |
VWWorkBasketDefinition.deleteWorkBasketColumnDefinition(java.lang.String workBasketColumnName)
Removes the specified work basket column from the work basket definition. |
VWWorkBasketDefinition |
VWQueueDefinition.deleteWorkBasketDefinition(java.lang.String workBasketName)
Removes the specified workbasket. |
VWWorkBasketFilterDefinition |
VWWorkBasketDefinition.deleteWorkBasketFilterDefinition(java.lang.String workBasketFilterName)
Removes the specified work basket filter definition. |
void |
VWWorkObject.doAbort()
Unlocks this work object without updating its fields. |
void |
VWStepElement.doAbort()
Unlocks a work item associated with this instance without updating the fields on the work item. |
void |
VWInstructionElement.doAbort()
Deprecated. Unlocks the workflow object associated with the Instruction Element, without updating the workflow object fields. |
void |
VWWorkObject.doDelete(boolean overrideLock,
boolean force)
Delete this work object. |
static VWException[] |
VWWorkObject.doDeleteMany(VWWorkObject[] elements,
boolean overrideLock,
boolean force)
Deletes the specified work objects. |
void |
VWWorkObject.doDispatch()
Saves changes made in this work object, unlocks it, and moves the current step to the next workflow step. |
void |
VWStepElement.doDispatch()
Saves changes made to the work object associated with this instance, unlocks the work object, and advances the work object in the workflow. |
void |
VWInstructionElement.doDispatch()
Deprecated. 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. |
void |
VWWorkObject.doLock(boolean overrideLock)
Locks the work object. |
void |
VWStepElement.doLock(boolean overrideLock)
Locks the work item associated with this step. |
void |
VWInstructionElement.doLock(boolean overrideLock)
Deprecated. Locks a workflow object. |
static VWException[] |
VWInstructionElement.doLockMany(VWInstructionElement[] intrs,
boolean overrideLock)
Deprecated. Locks Instruction Elements associated with workflow objects in a single call. |
static VWException[] |
VWWorkObject.doLockMany(VWWorkObject[] wobjs,
boolean overrideLock)
Locks multiple work objects in a single call and refreshes them with current information. |
void |
VWWorkObject.doReassign(java.lang.String participant,
boolean delegateFlag,
java.lang.String queueName)
Delegates the current step assignment associated with this work object to another participant. |
void |
VWStepElement.doReassign(java.lang.String participant,
boolean delegateFlag,
java.lang.String queueName)
Changes the participant responsible for processing this step. |
void |
VWWorkObject.doReassignByDomain(java.lang.String theDomainName,
java.lang.String participant,
boolean delegateFlag,
java.lang.String queueName)
Changes the participant responsible for processing the current step. |
void |
VWStepElement.doReassignByDomain(java.lang.String theDomainName,
java.lang.String participant,
boolean delegateFlag,
java.lang.String queueName)
Changes the participant responsible for processing this step. |
void |
VWWorkObject.doRefresh(boolean lock,
boolean overrideLock)
Retrieves an updated version of the work object to get recent data. |
void |
VWStepElement.doRefresh(boolean lock,
boolean overrideLock)
Updates the information for the work item. |
void |
VWInstructionElement.doRefresh(boolean lock,
boolean overrideLock)
Deprecated. Fetches the specified Instruction Element to get the most current information. |
void |
VWWorkObject.doReturnToSource()
Returns the work object to the queue from which it was originally reassigned or delegated. |
void |
VWStepElement.doReturnToSource()
Returns the work item to the queue from which a user originally reassigned or delegated the work item. |
void |
VWWorkObject.doSave(boolean unlock)
Saves this work object. |
void |
VWStepElement.doSave(boolean unlock)
Saves the work item associated with this instance. |
void |
VWInstructionElement.doSave(boolean unlock)
Deprecated. Saves the workflow object associated with the Instruction Element. |
static VWException[] |
VWInstructionElement.doSaveMany(VWInstructionElement[] invs)
Deprecated. Saves and updates information for each workflow object specified by the passed array of Instruction Elements. |
static VWException[] |
VWWorkObject.doSaveMany(VWWorkObject[] workObjects)
Saves information for an array of work objects. |
void |
VWWorkObject.doTerminate()
Terminate this work object. |
void |
VWInstructionElement.doTerminate()
Deprecated. Terminates the workflow object associated with the Instruction Element. |
static VWException[] |
VWInstructionElement.doTerminateMany(VWInstructionElement[] elements)
Deprecated. Terminates workflow objects associated with the passed Instruction Elements. |
static VWException[] |
VWWorkObject.doTerminateMany(VWWorkObject[] elements)
Terminates the specified work objects. |
static VWException[] |
VWInstructionElement.doUnlockMany(VWInstructionElement[] invs,
boolean save,
boolean dispatch)
Deprecated. Unlocks the array of workflow objects specified by the passed Instruction Elements. |
static VWException[] |
VWStepElement.doUnlockMany(VWStepElement[] stepElements,
boolean save,
boolean dispatch)
Unlocks an array of step elements. |
static VWException[] |
VWWorkObject.doUnlockMany(VWWorkObject[] workObjects,
boolean save,
boolean dispatch)
Unlocks an array of work objects. |
void |
VWWorkflowCollectionDefinition.export(java.io.OutputStream theStream,
VWSession session)
Writes this instance in a self-contained form to a specified output stream. |
static void |
VWXMLConfiguration.exportConfiguration(IVWtoXML[] apiObjects,
java.lang.StringBuffer buffer)
Creates an XML document in a StringBuffer representing the specified administration and configuration objects implementing the IVWtoXML interface. |
static void |
VWXMLConfiguration.exportConfigurationToFile(IVWtoXML[] apiObjects,
java.lang.String outputFile)
Creates an XML document file representing the specified administration and configuration objects implementing the IVWtoXML interface. |
void |
VWWorkflowCollectionDefinition.exportToFile(java.lang.String theFileName,
VWSession session)
Writes this instance in a self-contained form to a specified file. |
java.lang.Boolean[] |
VWSession.fetchAttachmentIsReferenced(VWAttachment[] theAttachments)
Checks an array of attachment objects to see if an active workflow is referencing any of the attachment objects and returns a Boolean value for each attachment, true if the attachment is referenced by a currently running workflow; false otherwise. |
VWRosterElement[] |
VWSession.fetchAttachmentIsReferencedBy(VWAttachment anAttachment)
Deprecated. Replaced by createAttachmentTrackingQuery |
VWRosterElement[] |
VWSession.fetchAttachmentIsReferencedBy(VWAttachment anAttachment,
int theLimit)
Deprecated. Replaced by VWSession.createAttachmentTrackingQuery(VWAttachment) |
VWAttributeInfo |
VWSession.fetchAttributes(int nFlag)
Fetches system-wide or region-specific attribute information from the Process Engine for the current logged-on session. |
java.util.Locale[] |
VWSession.fetchAvailableLocales()
Gets the set of available locales registered on the Process Engine server. |
int |
VWRosterQuery.fetchCount()
Returns the number of records that can be retrieved for the current VWRosterQuery object. |
int |
VWRoster.fetchCount()
Gets an integer that indicates the number of work items in the roster. |
int |
VWQueueQuery.fetchCount()
Gets the integer value indicating the number of records that can be retrieved, using this queueQuery object. |
int |
VWQueue.fetchCount()
Gets the integer value indicating the queue depth. |
int |
VWLogQuery.fetchCount()
Gets the integer value indicating the number of records that can be retrieved, using this logQuery definition. |
VWUserInfo |
VWSession.fetchCurrentUserInfo()
Gets information about the user logged on to this session. |
VWLog |
VWSession.fetchEventLog(java.lang.String eventLogName)
Retrieves the specified event log. |
java.lang.String[] |
VWSession.fetchEventLogNames()
Returns a list of all event log names. |
java.lang.String |
VWSession.fetchFileFromServer(java.lang.String theFileName,
int theFileType)
Gets a file for the Process Engine server. |
VWWorkflowHistory |
VWProcess.fetchFilteredWorkflowHistory(int mapId,
int filterFlag)
Fetches step history data for the current workflow process associated with the specified workflow map. |
VWMilestoneElement[] |
VWProcess.fetchFilteredWorkflowMilestones(int level,
boolean bLastOnly,
boolean bReachedOnly)
Fetches the milestone data for this workflow process, based on the filtering levels specified. |
java.lang.String[] |
VWQueue.fetchIndexFields()
Deprecated. Replaced by fetchQueueDefinition
Fetches the user-defined index names
for a specified queue. |
java.lang.String[] |
VWQueue.fetchIndexKeyFields(java.lang.String indexField)
Deprecated. Replaced by fetchQueueDefinition
Fetches the ordered fields of a user-defined
search index, given a search field name. The order determines
which field the application uses in the primary sort, each
subsequent field being less significant than the previous. |
VWInstructionElement |
VWWorkObject.fetchInstructionElement(boolean lock,
boolean overrideLock)
Deprecated. Use fetchStepElement instead.
Fetches the instruction element information associated with
this work object. |
VWInstructionElement |
VWRosterElement.fetchInstructionElement(boolean lock,
boolean overrideLock)
Deprecated. Replaced by fetchStepElement |
VWInstructionElement |
VWQueueElement.fetchInstructionElement(boolean lock,
boolean overrideLock)
Deprecated. Use fetchStepElement instead.
Fetches the corresponding instruction element for the workflow
object associated with the queue element. If a translation source
exists, the authored instruction element information is translated. |
VWInstructionElement[] |
VWQueueQuery.fetchInstructionElements(int bufferSize)
Deprecated. Replaced by VWQueueQuery.next() |
boolean[] |
VWSession.fetchIsGroup(java.lang.String[] names)
Indicates whether or not the members of a list of names are names of groups. |
java.lang.String[] |
VWSession.fetchLaunchableWorkClassNames()
Retrieves a list of the names of all work classes within the isolated region that can be launched by the current user. |
VWStepProcessorInfo |
VWSession.fetchLaunchStepProcessor(java.lang.String workflowIdentifier)
Retrieves the launch step processor information, based on the specified workflow version (obtained from a VWTransferResult object). |
boolean |
VWSession.fetchLimitApplicationFunctionalityFlag()
Returns the value of the Full Workflow Functionality flag set in the Process Task Manager. |
int |
VWWorkObject.fetchLockedStatus()
Retrieves the lock status of the work object. |
int |
VWInstructionElement.fetchLockedStatus()
Deprecated. Checks the status of the workflow object. |
VWLogDefinition |
VWLog.fetchLogDefinition()
Fetches the log definition. |
VWMilestoneElement[] |
VWSession.fetchMilestonesFromRoster(java.lang.String rosterName,
java.lang.String queryValue,
int queryFlag,
int milestoneLevel)
Fetches the milestone data for the current workflow process having work objects in the specified roster. |
VWWorkflowSignature[] |
VWSession.fetchMultipleWorkflowSignatures(int flags)
Returns an array of workflow signatures. |
VWRole |
VWSession.fetchMyRole(java.lang.String roleName,
java.lang.String appSpaceName)
Retrieves the specified role associated with the user currently logged in. |
VWRole[] |
VWSession.fetchMyRoles(java.lang.String appSpaceName)
Retrieves the roles associated with the user currently logged in. |
VWWorkBasket.QueryResults |
VWWorkBasket.fetchNextBatch(int query_flags,
int buffer_size,
java.lang.String sort_column,
java.lang.String[] filter_names,
java.lang.Object[] substitution_vars,
java.lang.String lastWorkRecStr,
int fetch_type)
Gets the next batch of query results based on the specified criteria. |
java.lang.String[] |
VWQueue.fetchOperationNames()
Fetches the list of all the operation names for this queue. |
VWParticipant[] |
VWSession.fetchParticipantsPx(java.lang.String secDomainName,
java.lang.String[] theNameList)
Gets general user security information about specified users in a domain. |
int |
VWSession.fetchPrivileges()
Retrieves the privileges for the current user. |
VWProcess |
VWWorkObject.fetchProcess()
Retrieves the workflow process containing this instance. |
VWProcess |
VWStepElement.fetchProcess()
Retrieves the workflow process containing this instance. |
VWProcess |
VWSession.fetchProcess(int workSpaceId,
int workClassId,
java.lang.String workflowNumber)
Returns the workflow process containing this work object. |
VWQueueDefinition |
VWQueue.fetchQueueDefinition()
Fetches the definition for this queue. |
VWQueueElement[] |
VWQueueQuery.fetchQueueElements(int bufferSize)
Deprecated. Replaced by VWQueueQuery.next() |
java.lang.String[] |
VWQueue.fetchQueueFields()
Deprecated. Replaced by fetchQueueDefinition
Fetches the user-defined search
fields for a specified queue. |
java.lang.String[] |
VWSession.fetchQueueNames(int fetchFlag)
Retrieves the names of queues within the current isolated region and within the scope of the specified queue type or types. |
VWWorkflowMilestones |
VWProcess.fetchReachedWorkflowMilestones(int theLevel)
Fetches the milestone events reached, based on the milestone level specified. |
VWReturnStackElement[] |
VWWorkObject.fetchReturnStackElements()
Retrieves work object return stack. |
VWParticipant[] |
VWRoleDefinition.fetchRoleParticipants()
Retrieves the members (users and/or groups) of this role definition. |
VWRosterDefinition |
VWRoster.fetchRosterDefinition()
Fetches the definition for this roster. |
VWRosterElement[] |
VWRosterQuery.fetchRosterElements(int bufferSize)
Deprecated. Replaced by VWRosterQuery.next() |
java.lang.String[] |
VWSession.fetchRosterNames(boolean ignoreSecurity)
Retrieves a list of the names of all rosters within the isolated region. |
VWSecurityDomain[] |
VWSession.fetchSecurityDomains()
Returns all security domains. |
java.util.Locale |
VWSession.fetchServerLocale()
Gets the default locale for the Process Engine server. |
VWRosterStats |
VWRoster.fetchStatistics(java.util.Date startTime,
java.util.Date endTime,
int timeUnits)
Fetches statistical information for the roster, given a start and stop time. |
VWQueueStats |
VWQueue.fetchStatistics(java.util.Date startTime,
java.util.Date endTime,
int timeUnits)
Fetches statistical information for the queue, given a start and stop time. |
VWStepElement |
VWWorkObject.fetchStepElement()
Fetches the current step in the workflow process. |
VWStepElement |
VWRosterElement.fetchStepElement(boolean lock,
boolean overrideLock)
Fetches the current step in the workflow process. |
VWStepElement |
VWQueueElement.fetchStepElement(boolean lock,
boolean overrideLock)
Fetches the current step in the workflow process. |
VWStepHistory |
VWWorkflowHistory.fetchStepHistory(int stepId)
Fetches the latest history of the specified step. |
VWStepProcessorInfo |
VWWorkObject.fetchStepProcessorInfo()
Fetches the step processor information associated with this instance. |
VWStepProcessorInfo |
VWStepElement.fetchStepProcessorInfo()
Fetches the step processor information object that contains data that can used to open this instance. |
VWStepProcessorInfo |
VWQueueElement.fetchStepProcessorInfo()
Fetches the step processor information associated with this instance. |
VWStepProcessorInfo |
VWSession.fetchStepProcessorInfo(java.lang.String processorIdentifier)
Returns a step processor object defined for the current session and workflow definition, given the step processor ID. |
VWStepProcessorInfo[] |
VWSession.fetchStepProcessors(int processorFlag)
Retrieves a list of step processor information objects defined for the current session and workflow definition. |
VWSystemAdministration |
VWSession.fetchSystemAdministration()
Gets system administration information for the Process Engine. |
VWSystemConfiguration |
VWSession.fetchSystemConfiguration()
Gets system configuration information for a system. |
VWSecurityList |
VWSession.fetchUserGroups(int maxBufferSize)
Deprecated. Replaced by VWSession.findGroups(String searchPattern, int searchType, int sortType, int maxBufferSize) |
VWParticipantList |
VWSession.fetchUserGroupsPx(int maxBufferSize)
Deprecated. Replaced by VWSession.findGroupsByDomain(String secDomainName, String searchPattern, int searchType, int sortType, int maxBufferSize) |
VWUserInfo |
VWSystemAdministration.fetchUserInfo(java.lang.String theUserName)
Fetches information about a specified user. |
VWUserInfo |
VWSession.fetchUserInfo(java.lang.String theName)
Gets general user information about a specified user. |
VWUserInfo[] |
VWSession.fetchUserInfoList(java.lang.String[] theNameList)
Gets general user information about specified users. |
VWUserInfo[] |
VWSession.fetchUserRecords(int maxBufferSize,
boolean throwException)
Fetches a collection of all user environment records that exists on the Process Engine. |
VWSecurityList |
VWSession.fetchUsers(int maxBufferSize,
boolean bIncludeGroups)
Deprecated. Replaced by VWSession.findUsers(String searchPattern, int searchType, int sortType, int maxBufferSize)
VWSession.findGroups(String searchPattern, int searchType, int sortType, int maxBufferSize) |
VWParticipantList |
VWSession.fetchUsersPx(int maxBufferSize,
boolean bIncludeGroups)
Deprecated. Replaced by VWSession.findUsersByDomain(String secDomainName, String searchPattern, int searchType, int sortType, int maxBufferSize)
VWSession.findGroupsByDomain(String secDomainName, String searchPattern, int searchType, int sortType, int maxBufferSize) |
VWWorkBasket |
VWQueue.fetchWorkBasket(java.lang.String workBasketName)
|
VWWorkBasket |
VWRole.fetchWorkBasket(java.lang.String queueName,
java.lang.String workBasketName)
Retrieves the specified work basket for this role. |
VWWorkBasket[] |
VWRole.fetchWorkBaskets()
Retrieves the VWWorkBaskets that this role references. |
VWWorkBasket[] |
VWQueue.fetchWorkBaskets()
Gets all of the workbaskets associated with this queue. |
java.lang.String[] |
VWSession.fetchWorkClassNames(boolean ignoreSecurity)
Retrieves a list of the names of all work classes within the isolated region. |
java.lang.String[] |
VWSession.fetchWorkClassNames(boolean ignoreSecurity,
java.lang.String inheritFromWorkClassName)
Retrieves a list of the names of the work classes within the current isolated region that inherit from the specified work class. |
VWWorkflowDefinition |
VWProcess.fetchWorkflowDefinition()
Deprecated. Replaced by fetchWorkflowDefinition
Fetches the workflow definition for this workflow process. |
VWWorkflowDefinition |
VWProcess.fetchWorkflowDefinition(boolean convert)
Fetches the workflow definition for this workflow process. |
VWWorkflowDefinition |
VWSession.fetchWorkflowDefinition(int workSpaceId,
java.lang.String workflowIdentifier)
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. |
VWWorkflowDefinition |
VWSession.fetchWorkflowDefinition(int workSpaceId,
java.lang.String workflowIdentifier,
boolean convert)
Fetches a workflow definition, based on the specified workspace ID and the work class name or the workflow version. |
VWWorkflowHistory |
VWProcess.fetchWorkflowHistory(int instructionSheetID)
Fetches the history data for this workflow process that is associated with this workflow instruction sheet ID. |
VWWorkflowSignature |
VWSession.fetchWorkflowSignature(java.lang.String workflowIdentifier)
Retrieves the workflow signature, based on the specified work class name or workflow version. |
VWWorkObject |
VWStepElement.fetchWorkObject(boolean lock,
boolean overrideLock)
Retrieves the work object associated with this instance. |
VWWorkObject |
VWRosterElement.fetchWorkObject(boolean lock,
boolean overrideLock)
Fetches the work object that corresponds to this roster element. |
VWWorkObject |
VWQueueElement.fetchWorkObject(boolean lock,
boolean overrideLock)
Fetches the workflow object associated with this queue element. |
VWWorkObject |
VWInstructionElement.fetchWorkObject(boolean lock,
boolean overrideLock)
Deprecated. Fetches a workflow object specified in the Instruction Element. |
VWWorkObject[] |
VWRosterQuery.fetchWorkObjects(int bufferSize)
Deprecated. Replaced by VWRosterQuery.next() |
VWWorkObject[] |
VWQueueQuery.fetchWorkObjects(int bufferSize)
Deprecated. Replaced by VWQueueQuery.next() |
VWSecurityList |
VWSession.findGroups(java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
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. |
VWParticipantList |
VWSession.findGroupsByDomain(java.lang.String secDomainName,
java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
Fetches a collection of all group names defined within the specified LDAP security domain, matching them for inclusion in the result collection according to this method's search pattern and search type arguments. |
VWSecurityList |
VWSession.findUsers(java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
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. |
VWParticipantList |
VWSession.findUsersByDomain(java.lang.String secDomainName,
java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
Fetches a collection of all user names defined within the specified LDAP security domain, matching them for inclusion in the result collection according to this method's search pattern and search type arguments. |
VWAssociationDefinition[] |
VWTextAnnotationDefinition.getAllAssociations()
Gets all associations from this text annotation. |
VWApplicationSpaceDefinition |
VWSystemConfiguration.getApplicationSpaceDefinition(java.lang.String name)
Gets an application space definition. |
VWApplicationSpaceDefinition[] |
VWSystemConfiguration.getApplicationSpaceDefinitions()
Gets all of the application space definitions associated with this system configuration. |
java.lang.String |
VWWebServiceParameterDefinition.getArrayAttributes()
Returns the attributes for an array specified by an array tag and array namespace, for this parameter. |
java.lang.String |
VWWebServiceParameterDefinition.getArrayNameSpace()
Returns the namespace for the array tag associated with this parameter |
java.lang.String |
VWWebServiceParameterDefinition.getArrayTag()
Returns the array tag name for this parameter; may be null |
VWAssociationDefinition |
VWTextAnnotationDefinition.getAssociation(int targetId,
int targetType)
Gets a specified assocation from this text annotation. |
VWAttributeInfo |
VWWorkflowDefinition.getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
VWAttributeInfo |
VWWorkBasketFilterDefinition.getAttributeInfo()
Gets the work basket filter definition attributes as paired labels (hash table keys) and values in String format. |
VWAttributeInfo |
VWWorkBasketDefinition.getAttributeInfo()
Gets the work basket definition attributes as paired labels (hashtable keys) and values in String format. |
VWAttributeInfo |
VWWorkBasketColumnDefinition.getAttributeInfo()
Gets the workbasket column definition attributes as paired labels (hashtable keys) and values in String format. |
VWAttributeInfo |
VWWorkBasket.getAttributeInfo()
Gets the workbasket attributes as paired labels (hashtable keys) and values in String format. |
VWAttributeInfo |
VWWorkBasket.Filter.getAttributeInfo()
Gets the workbasket filter attributes as paired labels (hashtable keys) and values in String format. |
VWAttributeInfo |
VWSystemConfiguration.getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
VWAttributeInfo |
VWSystemAdministration.getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
VWAttributeInfo |
VWRouteDefinition.getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
VWAttributeInfo |
VWRoleDefinition.getAttributeInfo()
Gets the role definition attributes as paired labels (hashtable keys) and values in String format. |
VWAttributeInfo |
VWQueueDefinition.getAttributeInfo()
Gets the attributes for this instance, as paired labels (keywords) and values. |
VWAttributeInfo |
VWOperationDefinition.getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
VWAttributeInfo |
VWMapNode.getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
VWAttributeInfo |
VWApplicationSpaceDefinition.getAttributeInfo()
Gets the attributes as paired labels (hashtable keys) and values in String format. |
java.lang.String[] |
VWAttributeInfo.getAttributeNames()
Gets the attribute names. |
java.lang.String |
VWWebServiceParameterDefinition.getAttributes()
Returns the attributes for this parameter, as they are applied to this combination of namespace and parameter name. |
java.lang.String |
VWWorkBasketFilterDefinition.getAuthoredName()
Gets the original name of the work basket filter definition. |
java.lang.String |
VWWorkBasketDefinition.getAuthoredName()
Gets the authored name assigned to the work basket definition. |
java.lang.String |
VWWorkBasketColumnDefinition.getAuthoredName()
Gets the name originally assigned to the workbasket column definition. |
java.lang.String |
VWWorkBasket.getAuthoredName()
Gets the original workbasket name. |
java.lang.String |
VWWorkBasket.Column.getAuthoredName()
Gets the original name of the workbasket column. |
java.lang.String |
VWWorkBasket.Filter.getAuthoredName()
Gets the original name of the workbasket filter. |
java.lang.String |
VWRoleDefinition.getAuthoredName()
Gets the original role definition name. |
java.lang.String |
VWParameter.getAuthoredName()
Gets the authored, untranslated name of the parameter. |
java.lang.String |
VWIndexDefinition.getAuthoredName()
Gets the string containing the authored, untranslated name of the index field. |
java.lang.String |
VWExposedFieldDefinition.getAuthoredName()
Gets the authored, untranslated name of this exposed data field. |
java.lang.String |
VWDataField.getAuthoredName()
Gets the authored, untranslated name of a field. |
java.lang.String |
VWApplicationSpaceDefinition.getAuthoredName()
Gets the original application space name. |
java.lang.String |
VWWorkObject.getAuthoredStepName()
Gets the authored (untranslated) step name for this work object. |
java.lang.String |
VWStepElement.getAuthoredStepName()
Gets the authored (untranslated) name of this step. |
java.lang.String |
VWRosterElement.getAuthoredStepName()
Gets the authored step name for this roster element. |
java.lang.String |
VWQueueElement.getAuthoredStepName()
Gets the authored step name for this queue element. |
java.lang.String |
VWLogElement.getAuthoredStepName()
Gets the authored (untranslated) step name for this log element. |
int |
VWParticipantHistory.getBoundUserId()
Returns the bound user ID. |
boolean |
VWStepElement.getCanReassign()
Indicates whether the work item can be reassigned. |
boolean |
VWStepElement.getCanReturnToSource()
Indicates whether the work item can be returned to the queue from which the user delegated or reassigned it. |
boolean |
VWStepElement.getCanViewHistory()
Determines whether this step element's history can be viewed through the step processor. |
boolean |
VWStepElement.getCanViewStatus()
Indicates whether this instance can be viewed through the tracker application. |
VWFaultDefinition |
VWInvokeInstruction.getCatchAllFault()
Gets the general fault-handling (catch all) fault for this instance. |
java.lang.String |
VWInvokeInstruction.getCatchAllMap()
Gets the general fault-handling (catch all) fault map for this instance. |
java.lang.String |
VWInvokeInstruction.getCatchAllMessage()
Gets the general fault-handling (catch all) fault message location from this instance. |
java.util.Locale |
VWSession.getClientLocale()
Get the client locale to be used when translating to a language other than the default language of the Process Engine server. |
VWExposedFieldDefinition |
VWWorkBasketColumnDefinition.getColumn()
Gets the VWExposedFieldDefinition for the workbasket column definition. |
java.lang.String |
VWWorkObject.getComment()
Returns the comment for this step. |
java.lang.String |
VWStepElement.getComment()
Gets the comment for this instance. |
java.util.Date |
VWStepOccurrenceHistory.getCompletionDate()
Gets the date on which the all participants completed the work at this step occurrence. |
java.lang.String |
VWSession.getConnectionPointName()
Gets the name of the connection point used for this session. |
int |
VWMapDefinition.getContainingStepId(int theStepId)
Gets the ID of the compound step that contains the instruction referenced by the specified ID. |
int |
VWRoster.getCount()
Deprecated. Replaced by VWRoster.fetchCount() |
int |
VWQueue.getCount()
Deprecated. Replaced by VWQueue.fetchCount() |
VWParticipant[] |
VWRosterDefinition.getCreateSecurityPx()
Returns an array of VWParticipant objects that names the users and/or groups who have create access to the roster. |
java.lang.String |
VWStepElement.getCurrentMapName()
Gets the name of the map for this work item. |
java.lang.String |
VWWorkObject.getCurrentQueueName()
Returns the name of the queue in which this work object resides. |
java.lang.String |
VWStepElement.getCurrentQueueName()
Gets the name of the queue in which the work item resides. |
long |
VWSession.getCurrentUserSecId()
Returns the user ID for the user currently logged on. |
int |
VWSession.getDatabaseType()
Gets the database
configuration type for the workflow database. |
VWDataField |
VWWorkObject.getDataField(java.lang.String name)
Gets the requested data field from the log element. |
VWDataField |
VWRosterElement.getDataField(java.lang.String name)
Gets the requested data field from the log element. |
VWDataField |
VWQueueElement.getDataField(java.lang.String name)
Gets the requested data field from the log element. |
VWDataField |
VWLogElement.getDataField(java.lang.String name)
Gets the requested data field from this log element. |
VWDataField[] |
VWRosterElement.getDataFields()
Gets the list of data fields supported by this queue element. |
VWDataField[] |
VWQueueElement.getDataFields()
Gets the list of data fields supported by this queue element. |
VWDataField[] |
VWLogElement.getDataFields()
Gets the data fields supported by this log element. |
VWDataField[] |
VWWorkObject.getDataFields(int fieldTypeFlag,
int fieldCreatorFlag)
Returns a list of all data fields this work object supports. |
java.util.Date |
VWWorkObject.getDateReceived()
Returns the date on which the work object was last saved. |
java.util.Date |
VWStepOccurrenceHistory.getDateReceived()
Gets the date on which the participant first received the work. |
java.util.Date |
VWStepElement.getDateReceived()
Returns the date on which this instance was last saved. |
java.util.Date |
VWWorkObject.getDeadline()
Retrieve the date by which the step should be completed. |
java.util.Date |
VWStepElement.getDeadline()
Gets the date value representing the date by which the step must be completed. |
java.lang.String |
VWStepDefinition.getDeadlineExpr()
Retrieves the value of the deadline expression property for this step definition. |
VWLogDefinition |
VWSystemConfiguration.getDefaultLogDefinition()
Gets the default definition for event logging. |
VWSecurityDomain |
VWSession.getDefaultSecurityDomain()
Deprecated. P8 PE BPM 4.0 does not support the concept of "default security domain." |
int |
VWSession.getDefaultWebApplication()
Gets the default Web Application ID
for a logged-on session; the default web application is applied
to an initial transfer to a region. |
java.lang.String |
VWWorkBasketFilterDefinition.getDescription()
Gets the description of the work basket filter definition. |
java.lang.String |
VWWorkBasketDefinition.getDescription()
Gets the description of the work basket definition. |
java.lang.String |
VWWorkBasket.getDescription()
Gets the work basket description. |
java.lang.String |
VWWorkBasket.Filter.getDescription()
|
java.lang.String |
VWRoleDefinition.getDescription()
Gets the role definition description. |
java.lang.String |
VWParameter.getDescription()
Gets the description of the parameter. |
VWMapNode |
VWRouteDefinition.getDestinationStep()
Gets the information contained in the object that represents the step destination. |
long |
VWLogElement.getDuration()
Gets the duration of the logging period. |
java.lang.String |
VWProcess.getEventLogName()
Gets the event log name of this workflow process. |
VWEventDefinition[] |
VWWFEInstruction.getEvents()
Gets the events contained in this instance. |
int |
VWLogElement.getEventType()
Gets the event type of the log record. |
java.lang.String |
VWInstructionElement.getExceptionMap()
Deprecated. Gets the exception workflow map for the workflow object associated with the Instruction Element. |
boolean |
VWRuleSetDefinition.getExpensive()
Indicates whether asynchronous execution of this rule set is permitted. |
VWExposedFieldDefinition[] |
VWSystemConfiguration.getExposedFields()
Returns all the exposed fields on the queues, the rosters, and the logs. |
VWFaultDefinition |
VWInvokeInstruction.getFault(java.lang.String theName)
Retrieves a fault definition, specified by name. |
java.lang.String |
VWReplyInstruction.getFaultName()
Gets the fault name for this VWReplyInstruction instance. |
VWFaultDefinition[] |
VWInvokeInstruction.getFaults()
Gets the faults contained in this instance. |
VWFieldDefinition |
VWWorkflowDefinition.getField(java.lang.String theName)
Gets the definition of a data field from this workflow definition. |
VWExposedFieldDefinition |
VWRosterDefinition.getField(java.lang.String name)
Returns the field definition for the specified exposed field in this roster. |
VWExposedFieldDefinition |
VWQueueDefinition.getField(java.lang.String name)
Returns the specified exposed field definition for the queue definition. |
VWExposedFieldDefinition |
VWLogDefinition.getField(java.lang.String name)
Returns the specified exposed field definition for this instance. |
int |
VWInstructionElement.getFieldMode(java.lang.String fieldName)
Deprecated. Specifies the parameter mode for the specified field as IN, OUT, or INOUT. |
VWFieldDefinition[] |
VWWorkflowDefinition.getFields()
Gets the set of fields associated with this workflow definition. |
VWExposedFieldDefinition[] |
VWTableDefinition.getFields()
Get an array of exposed field definitions for this table definition. |
VWExposedFieldDefinition[] |
IVWTableDefinition.getFields()
Provides an array of exposed field definitions for this queue definition. |
int |
VWUserInfo.getFieldType(java.lang.String fieldName)
Returns the basic field type of the specified field name. |
int |
VWAttributeInfo.getFieldType(java.lang.String fieldName)
Returns the field type of the input field name. |
java.lang.Object |
VWWorkObject.getFieldValue(java.lang.String fieldName)
Retrieves the value of a data field. |
java.lang.Object |
VWUserInfo.getFieldValue(java.lang.String fieldName)
Returns an Object representing the specified field name. |
java.lang.Object |
VWRosterElement.getFieldValue(java.lang.String fieldName)
Gets the value of a specified field in this roster element. |
java.lang.Object |
VWQueueElement.getFieldValue(java.lang.String fieldName)
Gets the value of a specific field. |
java.lang.Object |
VWLogElement.getFieldValue(java.lang.String fieldName)
Gets the value of the named user-defined field. |
java.lang.Object |
VWInstructionElement.getFieldValue(java.lang.String fieldName)
Deprecated. Gets the value of the specified field. |
java.lang.Object |
VWAttributeInfo.getFieldValue(java.lang.String fieldName)
Gets the object value for the input field name. |
VWWorkflowDefinition |
VWWorkflowDefinition.getFlattenedCopy(VWSession theSession)
Returns a copy of this workflow that includes attributes inherited from the parent workflow. |
java.lang.String |
VWRoleDefinition.getHomePageURL()
Gets the URL of the home page for the role definition. |
int |
VWTextAnnotationDefinition.getId()
Gets the value of the id property associated with this annotation. |
VWWebServiceParameterDefinition |
VWInvokeInstruction.getInComingParameterDefinition(int theSequenceNumber)
Gets a parameter definition from the set of incoming parameter definitions stored in this instance. |
VWWebServiceParameterDefinition[] |
VWInvokeInstruction.getInComingParameterDefinitions()
Gets the incoming parameter definitions stored in this instance. |
VWIndexDefinition |
VWRosterDefinition.getIndex(java.lang.String name)
Get an index definition specified for this roster definition. |
VWIndexDefinition |
VWQueueDefinition.getIndex(java.lang.String name)
Gets the index definition specified for this queue definition. |
VWIndexDefinition |
VWLogDefinition.getIndex(java.lang.String name)
Gets the index definition specified for this log definition. |
VWIndexDefinition[] |
VWTableDefinition.getIndexes()
Get an array of index definitions for one of the following Process Engine table types: log, queue, or roster definition. |
VWIndexDefinition[] |
IVWTableDefinition.getIndexes()
Provides an array of index definitions for this queue definition |
java.lang.String |
VWWorkBasketDefinition.getIndexName()
Gets the search index assigned. |
java.lang.String |
VWWorkBasketColumnDefinition.getIndexName()
|
VWInstructionDefinition[] |
VWCompoundStepDefinition.getInstructions()
Gets the instructions contained in this VWCompoundStepDefinition instance. |
java.lang.String |
VWWorkObject.getInstructionSheetName()
Returns the name of the instruction sheet containing the instruction this work object is currently processing. |
java.lang.String |
VWQueueElement.getInstructionSheetName()
Gets the name of the instruction sheet for this workflow object. |
java.lang.String |
VWLogElement.getInstructionSheetName()
Gets the name of the instruction sheet for the work object. |
boolean |
VWStepWorkObjectHistory.getIsCompleted()
Determines whether or not process associated with the work item has been completed. |
boolean |
VWQueue.getIsConnectorQueue()
Indicates whether or not this queue is a connector queue. |
int |
VWSession.getIsolatedRegion()
Gets an integer that specifies the isolated region for the current session. |
boolean |
VWParticipantHistory.getIsSameParticipant(VWWorkObject wob)
Determines, by work object number, if the specified work object is the same as the work object for the current participant. |
boolean |
VWWorkObject.getIsTracker()
Determines whether this a tracker work object. |
boolean |
VWStepElement.getIsTracker()
Determines whether this instance is a tracker work item. |
java.lang.String |
VWWorkObject.getLastErrorNumber()
Returns the last error number of the return stack frame for this work object. |
java.lang.String |
VWWorkObject.getLastErrorText()
Returns the last error text of the return stack frame for this work object. |
java.util.Date |
VWWorkObject.getLaunchDate()
Returns the date on which the workflow process that contains this work object was launched. |
java.util.Date |
VWStepElement.getLaunchDate()
Gets the date on which the workflow process associated with this instance was started. |
java.util.Date |
VWRosterElement.getLaunchDate()
Gets the launch date of the workflow process that contains the work object. |
VWStepDefinition |
VWWorkflowDefinition.getLaunchStep()
Gets the launch step in this workflow definition. |
int |
VWWebServiceParameterDefinition.getLexicalLevel()
Returns the level of nesting (containment) for this parameter. |
static java.lang.String |
VWFieldType.getLocalizedDefinitionString(int theFieldDefinitionType)
Retrieves the localized string containing the value of the field definition type. |
static java.lang.String |
VWXMLSchemaSubType.getLocalizedString(int schemaSubType)
Gets a localized String representation of the action. |
static java.lang.String |
VWUserInfo.getLocalizedString(int theNotificationType)
Gets a localized representation of the notification type. |
static java.lang.String |
VWTimeUnitType.getLocalizedString(int timeUnitType)
Gets a localized String representation of the time unit type. |
static java.lang.String |
VWTableDefinition.getLocalizedString(int theConfigType)
Gets a localized string representation of the config type (roster, queue, or log). |
static java.lang.String |
VWSystemConfiguration.getLocalizedString(int theLogType)
Gets a localized String representation of the log type. |
static java.lang.String |
VWSplitType.getLocalizedString(int theSplitType)
Gets a localized string representation of the split type. |
static java.lang.String |
VWQueueDefinition.getLocalizedString(int theQueueType)
Gets a localized string representation of the queue type. |
static java.lang.String |
VWOperationType.getLocalizedString(int theOperationType)
Gets a localized string representation of the operation type. |
static java.lang.String |
VWNodeType.getLocalizedString(int theNodeType)
Get a localized String representation of the node type. |
static java.lang.String |
VWModeType.getLocalizedString(int theModeType)
Gets a localized string representation of the mode type. |
static java.lang.String |
VWMergeType.getLocalizedString(int theMergeType)
Gets a localized string representation of the merge type. |
static java.lang.String |
VWLoggingOptionType.getLocalizedString(int loggingEventType)
Gets a localized String representation of the logging option type. |
static java.lang.String |
VWLibraryType.getLocalizedString(int theLibraryType)
Gets a localized string containing a description of the library or Object Store type. |
static java.lang.String |
VWJoinType.getLocalizedString(int theJoinType)
Gets a localized String representation of the join type. |
static java.lang.String |
VWFieldType.getLocalizedString(int theFieldType)
Retrieves the localized string containing the value of the field type. |
static java.lang.String |
VWFetchType.getLocalizedString(int fetchType)
Gets the localized fetch type description. |
static java.lang.String |
VWAttachmentType.getLocalizedString(int theAttachmentType)
Gets a localized string associated with a valid attachment type integer value. |
static java.lang.String |
VWAssociationTargetType.getLocalizedString(int targetType)
Get a localized String representation of the this instance. |
static java.lang.String |
VWActionType.getLocalizedString(int actionType)
Gets a localized String representation of the action. |
java.awt.Point |
VWTextAnnotationDefinition.getLocation()
Gets the value of the location property associated with this annotation. |
int |
VWQueueElement.getLockedMachine()
Gets the machine type of the system that locked the workflow object. |
int |
VWQueueElement.getLockedStatus()
Determines the lock status for the workflow object. |
java.lang.String |
VWWorkObject.getLockedUser()
Returns the name of the user who locked the work object. |
java.lang.String |
VWQueueElement.getLockedUser()
Returns the name of the user who has locked the workflow object. |
VWParticipant |
VWWorkObject.getLockedUserPx()
Returns the VWParticipant (security) object that represents the user who locked the current work object. |
VWParticipant |
VWStepElement.getLockedUserPx()
Returns the security object (VWParticipant) representing the user who locked the current work object. |
VWParticipant |
VWQueueElement.getLockedUserPx()
Returns the VWParticipant (security) object that represents the user who locked the current work object. |
VWLogDefinition |
VWSystemConfiguration.getLogDefinition(java.lang.String name)
Gets a log definition, specified by name. |
VWLogDefinition[] |
VWSystemConfiguration.getLogDefinitions()
Gets the log definitions associated with this system configuration object. |
VWDataField[] |
VWParticipantHistory.getLogFields()
Returns the exposed log fields. |
int |
VWLogElement.getMachineId()
Retrieves the system type of the machine associated with the log element. |
VWMapDefinition |
VWWorkflowDefinition.getMainMap()
Gets the main map for this workflow definition. |
VWMapDefinition |
VWWorkflowDefinition.getMap(int theMapId)
Deprecated. Replaced by VWWorkflowDefinition.getMap(String) . Note: getMap(String) takes
a map name as a parameter, rather than a map ID. |
VWMapDefinition |
VWWorkflowDefinition.getMap(java.lang.String theName)
Retrieves a workflow map based on the specified map name. |
int |
VWMapDefinition.getMapId()
Gets this map ID. |
int |
VWWorkflowDefinition.getMapIndex(java.lang.String theName)
Returns the index of the specified workflow map associated with this workflow definition. |
java.lang.String |
VWQueueElement.getMapName()
Gets the name of the map for this workflow object. |
java.lang.String |
VWLogElement.getMapName()
Gets the name of the workflow map of the work object. |
VWMapDefinition[] |
VWWorkflowDefinition.getMaps()
Gets the set of workflow maps associated with this workflow definition. |
java.lang.String |
VWTextAnnotationDefinition.getMessage()
Gets the value of the message property associated with this annotation. |
VWMilestoneDefinition |
VWWorkflowDefinition.getMilestone(java.lang.String theName)
Gets the definition of a milestone from this workflow definition. |
VWMilestoneDefinition[] |
VWProcess.getMilestoneDefinitions()
Gets the milestone data for this workflow process. |
VWMilestoneDefinition[] |
VWWorkflowDefinition.getMilestones()
Returns the milestones for this workflow definition. |
java.lang.String |
VWWorkBasketFilterDefinition.getName()
Gets the current name of the work basket filter definition. |
java.lang.String |
VWWorkBasketDefinition.getName()
Gets the name assigned to the work basket definition. |
java.lang.String |
VWWorkBasketColumnDefinition.getName()
Gets the current name for the workbasket column definition. |
java.lang.String |
VWWorkBasket.getName()
Gets the current workbasket name. |
java.lang.String |
VWWorkBasket.Column.getName()
Gets the name of the workbasket column. |
java.lang.String |
VWWorkBasket.Filter.getName()
Gets the name of the workbasket filter. |
java.lang.String |
VWTextAnnotationDefinition.getName()
Gets the value of the name property associated with this annotation. |
java.lang.String |
VWRoleDefinition.getName()
Gets the current role definition name. |
VWParticipant |
VWUserInfo.getNamePx()
Returns the VWParticipant security object for the current user. |
java.lang.String |
VWWebServiceParameterDefinition.getNameSpace()
Returns the namespace for this parameter. |
VWRouteDefinition[] |
VWMapNode.getNextRoutes()
Gets the definition of each outbound route associated with the current node. |
int |
VWWorkBasketDefinition.getObjId()
Gets the object ID of the work basket definition. |
int |
VWRoleDefinition.getObjId()
Gets the object ID of this role definition. |
int |
VWApplicationSpaceDefinition.getObjId()
Gets the object ID of this application space definition. |
VWOperationDefinition |
VWQueueDefinition.getOperation(java.lang.String theName)
Gets the definition of an operation existing in this queue. |
java.lang.String |
VWWorkObject.getOperationName()
Returns the name of the current operation on this work object. |
java.lang.String |
VWStepElement.getOperationName()
Gets the name of the current operation on this work item. |
java.lang.String |
VWQueueElement.getOperationName()
Gets the current operation name for this workflow object. |
java.lang.String |
VWLogElement.getOperationName()
Gets the operation name of this log element. |
java.lang.String |
VWInstructionElement.getOperationName()
Deprecated. Gets the name of the current Operation. |
VWOperationDefinition[] |
VWQueueDefinition.getOperations()
Gets all of the operation definitions existing in this queue. |
int |
VWWorkObject.getOperationType()
Returns the operation type of the current work order. |
int |
VWWorkBasketFilterDefinition.getOperator()
Gets the operator applied to the search field used for filtering. |
int |
VWWorkBasket.Filter.getOperator()
Gets the search field operator used for filtering. |
java.lang.String |
VWWorkObject.getOriginator()
Returns the name of the user who initiated the workflow process that contains this work object. |
java.lang.String |
VWStepElement.getOriginator()
Returns the name of the user who initiated the workflow process containing this instance. |
java.lang.String |
VWRosterElement.getOriginator()
Returns the name of the user who initiated the workflow process that contains this work object. |
VWParticipant |
VWWorkObject.getOriginatorPx()
Returns the VWParticipant (security) object that represents the user who initiated the workflow process containing the current step. |
VWParticipant |
VWWorkflowHistory.getOriginatorPx()
Returns the VWParticipant (security) object that represents the user who initiated the workflow process containing the current step. |
VWParticipant |
VWStepElement.getOriginatorPx()
Returns the security object (VWParticipant) representing the user who initiated the workflow process containing this instance. |
VWParticipant |
VWRosterElement.getOriginatorPx()
Returns the VWParticipant (security) object that represents the user who initiated the workflow process containing the current step. |
VWWebServiceParameterDefinition |
VWInvokeInstruction.getOutGoingParameterDefinition(int theSequenceNumber)
Gets a parameter definition from the set of outgoing parameter definitions stored in this instance. |
VWWebServiceParameterDefinition[] |
VWInvokeInstruction.getOutGoingParameterDefinitions()
Gets the outgoing parameter definitions stored in this instance. |
int |
VWWorkObject.getOverdue()
Returns the status of the overdue notice. |
int |
VWStepElement.getOverdue()
Gets status of the overdue notice. |
java.util.Date |
VWParticipantHistory.getOverdue()
Gets the overdue date/time information. |
VWParameter |
VWStepElement.getParameter(java.lang.String name)
Gets the requested parameter from this step element. |
VWParameter[] |
VWInstructionElement.getParameterDataFields()
Deprecated. Gets the data fields for the Instruction Element, which excludes participant lists and attachments. |
VWWebServiceParameterDefinition |
VWReplyInstruction.getParameterDefinition(int theSequenceNumber)
Gets a parameter definition from the set of parameter definitions stored in this reply instruction. |
VWWebServiceParameterDefinition |
VWReceiveInstruction.getParameterDefinition(int theSequenceNumber)
Gets a parameter definition from the set of parameter definitions stored in this receive instruction. |
VWParameterDefinition |
VWStepDefinition.getParameterDefinition(java.lang.String theName)
Gets a parameter definition from the set of parameter definitions stored in this step definition. |
VWParameterDefinition |
VWOperationDefinition.getParameterDefinition(java.lang.String theName)
Gets a parameter definition from the set of parameter definitions stored in this operation definition. |
VWParameterDefinition |
VWCompoundStepDefinition.getParameterDefinition(java.lang.String theName)
A stub method, always returning null, implemented to make this class conform to the IVWHasParameterDefs interface. |
VWParameterDefinition[] |
VWStepDefinition.getParameterDefinitions()
Gets the parameter definitions stored in this step definition. |
VWWebServiceParameterDefinition[] |
VWReplyInstruction.getParameterDefinitions()
Gets a parameter definition from the set of parameter definitions stored in this reply instruction. |
VWWebServiceParameterDefinition[] |
VWReceiveInstruction.getParameterDefinitions()
Gets the parameter definitions stored in this receive instruction. |
VWParameterDefinition[] |
VWOperationDefinition.getParameterDefinitions()
Gets the parameters of this operation. |
VWParameter[] |
VWStepElement.getParameters(int fieldTypeFlag,
int fieldCreatorFlag)
Returns the parameters used in this instance based on the specified parameter type (field type) and creator type. |
java.lang.Object |
VWStepElement.getParameterValue(java.lang.String parameterName)
Gets the value of a specified parameter for this instance. |
java.lang.String |
VWLogElement.getParentWorkObjectNumber()
Gets the string version of the parent work object number. |
java.lang.String |
VWWorkObject.getParticipantName()
Returns the short name of the participant who is processing this work object. |
java.lang.String |
VWStepElement.getParticipantName()
Returns the short name of the participant who is processing this instance. |
java.lang.String |
VWParticipantHistory.getParticipantName()
Returns the short name of the current participant, as a String. |
VWParticipant |
VWWorkObject.getParticipantNamePx()
Returns a VWParticipant (security) object that represents the current participant. |
VWParticipant |
VWStepElement.getParticipantNamePx()
Returns the security object (VWParticipant) representing the current participant. |
VWParticipant |
VWParticipantHistory.getParticipantNamePx()
Returns a VWParticipant (security) object that represents the current participant. |
VWPartnerLinkDefinition |
VWWorkflowDefinition.getPartnerLink(java.lang.String theName)
Gets the definition of a partner link from this workflow definition. |
VWPartnerLinkDefinition[] |
VWWorkflowDefinition.getPartnerLinks()
Retrieves all of the partner links for this workflow definition. |
java.lang.String |
VWSession.getPEServerName()
Gets the Network Clearing House (NCH) domain name for the Process Engine server. |
java.util.Locale |
VWUserInfo.getPreferredLocale()
Gets the preferred locale to be used for email notification. |
VWRouteDefinition[] |
VWMapNode.getPreviousRoutes()
Gets the definition of each inbound route associated with this step. |
VWProcess |
VWWorkObject.getProcess()
Deprecated. Replaced by fetchProcess |
VWProcess |
VWRosterElement.getProcess()
Deprecated. Replaced by VWStepElement.fetchProcess() or
VWWorkObject.fetchProcess() , depending on the type of process. |
int |
VWQueueElement.getProcessorId()
Fetches the step processor object containing the information needed to launch a workflow. |
java.lang.String |
VWWorkBasketFilterDefinition.getPrompt()
Gets the prompt used for the work basket filter definition. |
java.lang.String |
VWWorkBasketColumnDefinition.getPrompt()
Gets the prompt used for the workbasket column definition. |
java.lang.String |
VWWorkBasket.Column.getPrompt()
Gets the entry prompt assigned to the workbasket column. |
java.lang.String |
VWWorkBasket.Filter.getPrompt()
Gets the entry prompt assigned to the workbasket filter. |
java.lang.String |
VWUserInfo.getProxyUserName()
Gets the proxy user name as a String. |
VWParticipant |
VWUserInfo.getProxyUserNamePx()
Gets the proxy user name as an instance of a VWParticipant object. |
java.lang.String |
VWWorkBasketDefinition.getQueryFilterString()
Gets the queue query filter string. |
VWQueue |
VWSession.getQueue(java.lang.String queueName)
Gets the queue object identified by the specified queue name. |
VWQueueDefinition |
VWSystemConfiguration.getQueueDefinition(java.lang.String name)
Gets the queue definition with with specified name, for the current isolated region. |
VWQueueDefinition[] |
VWSystemConfiguration.getQueueDefinitions()
Lists all queue definitions for the current configuration. |
java.lang.String |
VWWorkBasketDefinition.getQueueName()
Gets the name of the queue associated with the work basket definition. |
java.lang.String |
VWStepElement.getQueueName()
Gets the queue class name for this instance. |
java.lang.String |
VWQueueElement.getQueueName()
Gets the name of the queue in which this work object currently resides. |
java.lang.String |
VWParticipantHistory.getQueueName()
Returns the name of the queue for this step. |
java.lang.String |
VWLogElement.getQueueName()
Gets the name of the queue that is associated with this log element and the current work object. |
java.lang.String[] |
VWSession.getQueueNames(boolean includeSystem)
Deprecated. Replaced by fetchQueueNames . |
int |
VWQueue.getQueueType()
Gets an integer value indicating the queue type. |
java.lang.String[] |
VWApplicationSpaceDefinition.getReadSecurity()
Deprecated. |
VWParticipant[] |
VWTableDefinition.getReadSecurityPx()
Returns an array of VWParticipant objects that specifies users and/or groups who have read access. |
VWParticipant[] |
VWRosterDefinition.getReadSecurityPx()
Returns an array VWParticipant objects that specifies the users and/or groups who currently have read access to the roster. |
VWParticipant[] |
VWQueueDefinition.getReadSecurityPx()
Gets the VWParticipant objects for the users and/or groups having Write access to this queue. |
VWParticipant[] |
VWApplicationSpaceDefinition.getReadSecurityPx()
Deprecated. |
java.util.Vector |
VWPartnerLinkDefinition.getReceiveInstructionRefs()
Gets a Vector of references to all receive instructions in the containing workflow that use this partner link. |
java.util.Date |
VWWorkObject.getReminder()
Returns the date on which a reminder is to be issued for the step. |
java.util.Date |
VWStepElement.getReminder()
Gets the date on which the application issues a reminder for this step. |
java.util.Date |
VWParticipantHistory.getReminder()
Gets reminder date/time information for the current participant. |
java.lang.String |
VWParticipantHistory.getResponse()
Returns the participant's response to the step. |
int |
VWWorkBasketDefinition.getRevision()
Gets the revision number of the work basket definition. |
int |
VWWorkBasket.getRevision()
Gets the revision number of the workbasket. |
int |
VWRoleDefinition.getRevision()
Gets the revision number for the role definition. |
int |
VWApplicationSpaceDefinition.getRevision()
Gets the revision number for the application space. |
VWRoleDefinition |
VWApplicationSpaceDefinition.getRoleDefinition(java.lang.String roleName)
Gets the specified role definition, or null if the role cannot be found. |
VWRoleDefinition[] |
VWApplicationSpaceDefinition.getRoleDefinitions()
Gets the role definitions. |
java.lang.String[] |
VWRoleDefinition.getRoleParticipantNames()
Gets the members (users and/or groups) of this role definition. |
VWRoster |
VWSession.getRoster(java.lang.String rosterName)
Gets the roster object identified by the specified roster name. |
VWRosterDefinition |
VWSystemConfiguration.getRosterDefinition(java.lang.String name)
Gets the roster definition with specified name. |
VWRosterDefinition[] |
VWSystemConfiguration.getRosterDefinitions()
Gets the roster definitions associated with the current isolated region. |
java.lang.String |
VWWorkObject.getRosterName()
Returns the name of the roster for this work object. |
java.lang.String |
VWStepElement.getRosterName()
Gets the name of the roster associated with this work item. |
java.lang.String |
VWRosterElement.getRosterName()
Gets the name of this roster. |
java.lang.String |
VWProcess.getRosterName()
Gets the roster name of this workflow process. |
java.lang.String[] |
VWSession.getRosterNames()
Deprecated. Replaced by VWSession.fetchQueueNames(int) or
VWSession.fetchRosterNames(boolean) . |
VWRouteDefinition |
VWMapNode.getRoute(int theRouteId)
Gets the route definition for the route ID specified. |
VWRouteDefinition |
VWMapNode.getRouteFrom(int theSourceStepId)
Gets the inbound route from another step. |
VWRouteDefinition |
VWMapNode.getRouteTo(int theDestinationStepId)
Gets the outbound route to another step. |
java.lang.String[] |
VWMapNode.getRuleSetNames(int ruleSetSelector)
Retrieves the names of the rulesets for this step definition, based on the type specified by the ruleSetSelector parameter. |
VWRuleSetDefinition[] |
VWWorkflowDefinition.getRuleSets()
Retrieves the rule sets for this workflow definition. |
VWRuleSetDefinition[] |
VWMapNode.getRuleSets(int ruleSetSelector)
Deprecated. Use getRuleSetNames() instead. With the inheritence of rulesets from parent workflows, there is no guarantee that this method will return a correct VWRuleSetDefinition object for all the rules on a step, although the name (returned by VWRuleSetDefinition.getValue() )
will be acurate. For backward compatibility, this method will continue to return
an array of VWRuleSetDefinition objects, but only the name will be guaranteed to be
correct. |
VWSchema |
VWWorkflowDefinition.getSchema(java.lang.String theName)
Gets the specified schema for this workflow definition. |
VWSchema[] |
VWWorkflowDefinition.getSchemas()
Retrieves the schemas for this workflow definition. |
int |
VWWebServiceParameterDefinition.getSchemaSubType()
Returns the schema sub type for this parameter. |
VWExposedFieldDefinition |
VWWorkBasketFilterDefinition.getSearchField()
Gets the search field used for filtering. |
int |
VWSession.getSecurityDatabaseType()
Returns the type of security database. |
java.lang.String |
VWWorkObject.getSelectedResponse()
Returns default response (the value in the F_Response system field) for this work object. |
java.lang.String |
VWStepElement.getSelectedResponse()
Gets the response selected by the user for this step. |
java.lang.String |
VWRosterElement.getSelectedResponse()
Returns the value in the F_Response system field for this object. |
java.lang.String |
VWQueueElement.getSelectedResponse()
Return the value in the F_Response system field for this object. |
java.lang.String |
VWLogElement.getSelectedResponse()
Returns the value in the F_Response field for this instance. |
int |
VWWebServiceParameterDefinition.getSequenceNumber()
Returns the unique sequence number for this parameter. |
int |
VWLogElement.getSequenceNumber()
Gets the simple sequence number of the record, beginning the count at 1 and increasing by one with each new record. |
int |
VWRosterElement.getServerLocation()
Gets the current server location of the work object. |
int |
VWInstructionElement.getServerLocation()
Deprecated. Gets the current server location of the work object. |
java.lang.String |
VWSession.getServerName()
Returns the name of the Process Engine's server for the current session. |
VWSession |
VWWebServiceParameterDefinition.getSession()
Get the session associated with this event definition. |
VWSession |
VWProcess.getSession()
Get the session associated with this mapnode definition. |
VWSession |
VWOperationDefinition.getSession()
Get the session associated with this operation definition. |
VWSession |
VWMapNode.getSession()
Get the session associated with this mapnode definition. |
VWSession |
VWFaultDefinition.getSession()
Get the session associated with this event definition. |
VWSession |
VWEventDefinition.getSession()
Get the session associated with this event definition. |
int |
VWSystemAdministration.getSessionTimeOut()
Gets the number minutes before a client/server session timeout. |
java.lang.String |
VWStepElement.getSourceDoc()
Returns the name of the source document for this instance. |
VWMapNode |
VWRouteDefinition.getSourceStep()
Gets the source node (step). |
VWMapNode |
VWMapDefinition.getStartStep()
Gets the start step definition for this map. |
int |
VWSystemAdministration.getStatisticsConsolidationInterval()
Gets the interval (minutes) between updates to the domain-wide statistics stored in the database. |
int |
VWSystemAdministration.getStatisticsSnapshotInterval()
Deprecated. Not replaced |
VWMapNode |
VWStepPaletteDefinition.getStep(int theStepId)
Returns the step with the specified id, if found. |
VWMapNode |
VWMapDefinition.getStep(int theStepId)
Gets the step definition identified by the specified ID. |
VWMapNode |
VWStepPaletteDefinition.getStep(java.lang.String theStepName)
Deprecated. Replaced by VWStepPaletteDefinition.getStep(int) |
int |
VWQueueElement.getStepDeadlineStatus()
Gets the deadline status for the current step. |
java.lang.String |
VWWorkObject.getStepDescription()
Gets the description of the step. |
java.lang.String |
VWStepElement.getStepDescription()
Gets the description of this instance. |
java.lang.String |
VWWorkObject.getStepName()
Gets the step label (name) for this work object. |
java.lang.String |
VWStepElement.getStepName()
Gets the name of this step. |
java.lang.String |
VWRosterElement.getStepName()
Gets the step label for this roster element. |
java.lang.String |
VWQueueElement.getStepName()
Gets the step label for this queue element. |
java.lang.String |
VWLogElement.getStepName()
Gets the step name for this log element. |
java.lang.String |
VWInstructionElement.getStepName()
Deprecated. Gets the step name for this instance. |
VWStepProcessorInfoDefinition |
VWSystemConfiguration.getStepProcessorInfoDefinition(java.lang.String name)
Gets a step processor info definition, specified by name. |
VWStepProcessorInfoDefinition[] |
VWSystemConfiguration.getStepProcessorInfoDefinitions()
Gets the VWStepProcessorInfoDefinition objects associated with this system configuration object. |
java.lang.String[] |
VWWorkObject.getStepResponses()
Returns the list of available responses for this work object. |
java.lang.String[] |
VWStepElement.getStepResponses()
Gets a list of available responses for this instance. |
VWMapNode[] |
VWStepPaletteDefinition.getSteps()
Gets the set of steps associated with this step palette. |
VWMapNode[] |
VWMapDefinition.getSteps()
Gets all of the steps contained in this map. |
int |
VWStepOccurrenceHistory.getStepStatus()
Gets the step status of this step occurrence |
int |
VWParticipantHistory.getStepStatus()
Returns the activity status for the participant working on the step. |
java.lang.String |
VWWorkObject.getSubject()
Returns the subject of the workflow (the value in the F_Subject system field) associated with this work object. |
java.lang.String |
VWStepElement.getSubject()
Gets the subject of the workflow associated with this instance. |
java.lang.String |
VWRosterElement.getSubject()
Returns the value in the F_Subject system field for this object. |
java.lang.String |
VWQueueElement.getSubject()
Returns the value in the F_Subject system field for this object. |
java.lang.String |
VWLogElement.getSubject()
Returns the value in the F_Subject field for this instance. |
int |
VWSystemAdministration.getSystemWideFlags()
Gets an integer that represents the combined system-wide configuration flags. |
java.lang.String |
VWWorkObject.getTag()
Returns a String version of the work object tag. |
java.lang.String |
VWStepElement.getTag()
Gets the work item tag. |
java.lang.String |
VWRosterElement.getTag()
Gets the tag of the work object (as a string). |
java.lang.String |
VWQueueElement.getTag()
Gets the tag of the workflow object. |
java.lang.String |
VWInstructionElement.getTag()
Deprecated. Gets the workflow object tag, as the workflow system stores it in the database. |
java.lang.String |
VWLogElement.getText()
Gets the text entered in the log. |
VWTextAnnotationDefinition |
VWMapDefinition.getTextAnnotation(int theAnnotationId)
Gets the annotation object in this map based on the specified ID. |
VWTextAnnotationDefinition[] |
VWMapDefinition.getTextAnnotations()
Gets all of the annotations contained in this map. |
java.util.Date |
VWLogElement.getTimeStamp()
Gets the timestamp of the current log record, as a date variable showing the time the log element was included in the log. |
java.lang.String |
VWSession.getToken()
Gets a token from the user logon, which a shared logon may use. |
java.lang.String[] |
VWWorkObject.getTrackers()
Deprecated. Replaced by VWWorkObject.getTrackersPx(), which returns an array of VWParticipant objects for the tracker participants associated with this work object. |
VWParticipant[] |
VWWorkObject.getTrackersPx()
Returns an array of VWParticipant objects for the tracker participants associated with this work object. |
VWParticipant |
VWWorkflowSignature.getTransferUserNamePx()
Returns the participant object for the user who transferred the associated workflow definition. |
int |
VWWorkBasketFilterDefinition.getType()
Gets the field type used for the work basket filter field. |
int |
VWWorkBasketColumnDefinition.getType()
Gets the field type used for the workbasket column field. |
int |
VWWorkBasket.Column.getType()
Gets the field type assigned to the workbasket column. |
int |
VWWorkBasket.Filter.getType()
Gets the field type assigned to the workbasket filter. |
boolean |
VWInvokeInstruction.getUseReliableMessaging()
Indicates whether reliable messaging is used this invoke instruction. |
java.lang.String |
VWParticipantHistory.getUserName()
Returns the name of the participant who completed, reassigned or delegated the work object for the step, as a String. |
java.lang.String |
VWLogElement.getUserName()
Gets the user name associated with the log record. |
VWParticipant |
VWParticipantHistory.getUserNamePx()
Returns a VWParticipant object for the participant who completed, reassigned or delegated the work object for this step. |
VWParticipant |
VWLogElement.getUserNamePx()
Gets the security object of the user associated with the log record. |
java.lang.Object |
VWParameter.getValue()
Gets the value of the parameter. |
java.lang.Object |
VWDataField.getValue()
Gets the value of a field as a valid field type object. |
java.lang.Object |
IVWField.getValue()
Get the value from the field as a java Object. |
VWWorkBasketColumnDefinition |
VWWorkBasketDefinition.getWorkBasketColumnDefinition(java.lang.String workBasketColumnName)
Gets the work basket column definition for the specified column. |
VWWorkBasketColumnDefinition[] |
VWWorkBasketDefinition.getWorkBasketColumnDefinitions()
Gets the work basket columns defined for the work basket definition. |
VWWorkBasketDefinition |
VWQueueDefinition.getWorkBasketDefinition(java.lang.String workBasketName)
Gets the specified workbasket definition for this queue. |
VWWorkBasketDefinition[] |
VWRoleDefinition.getWorkBasketDefinitions()
Gets the workbaskets defined for this role definition. |
VWWorkBasketDefinition[] |
VWQueueDefinition.getWorkBasketDefinitions()
Gets all of the workbasket definitions for this queue. |
VWWorkBasketFilterDefinition |
VWWorkBasketDefinition.getWorkBasketFilterDefinition(java.lang.String workBasketFilterName)
Gets the specified work basket filter definition. |
VWWorkBasketFilterDefinition[] |
VWWorkBasketDefinition.getWorkBasketFilterDefinitions()
Gets the work basket filters defined for the work basket definition. |
java.lang.String |
VWRole.WorkBasketReference.getWorkBasketName()
Gets the current name of the workbasket associated with this role. |
int |
VWStepElement.getWorkClassId()
Gets the ID of the work class for this work item. |
java.lang.String |
VWWorkObject.getWorkClassName()
Returns the name of the work class from which the application instantiates this work object. |
java.lang.String |
VWStepElement.getWorkClassName()
Gets the name of the work class from which the application instantiates the work item. |
java.lang.String |
VWQueueElement.getWorkClassName()
Gets the name of the work class from which this workflow object is instantiated. |
java.lang.String |
VWProcess.getWorkClassName()
Gets the work class name associated with this workflow process. |
java.lang.String |
VWLogElement.getWorkClassName()
Gets the name of the work class from which the current work object is instantiated. |
java.lang.String |
VWInstructionElement.getWorkClassName()
Deprecated. Gets the name of the work class which can be used to instantiate the workflow object. |
VWWorkflowDefinition |
VWWorkflowCollectionDefinition.getWorkflow(java.lang.String theName)
Retrieves a workflow definition from this collection, based on the specified name. |
int |
VWWorkflowCollectionDefinition.getWorkflowIndex(java.lang.String theName)
Returns the index into the array of workflow definitions in this collection for specified workflow. |
java.lang.String |
VWWorkObject.getWorkflowName()
Returns the name of the workflow associated with this step. |
java.lang.String |
VWStepElement.getWorkflowName()
Gets the name of the workflow associated with this instance. |
java.lang.String |
VWQueueElement.getWorkflowName()
Gets the name of the work class from which the workflow object logged was instantiated. |
java.lang.String |
VWLogElement.getWorkflowName()
Gets the name of the workflow. |
java.lang.String |
VWWorkObject.getWorkflowNumber()
Gets the workflow number. |
java.lang.String |
VWStepElement.getWorkflowNumber()
Gets the workflow number associated with this instance. |
java.lang.String |
VWRosterElement.getWorkflowNumber()
Gets the workflow number. |
java.lang.String |
VWWorkObject.getWorkFlowNumber()
Deprecated. Replaced by VWWorkObject.getWorkflowNumber() |
java.lang.String |
VWStepElement.getWorkFlowNumber()
Deprecated. Replaced by VWStepElement.getWorkflowNumber()
Gets the string version of the workflow number. Use the
returned F_WorkFlowNumber as an index key component. |
java.lang.String |
VWRosterElement.getWorkFlowNumber()
Deprecated. Replaced by VWRosterElement.getWorkflowNumber() |
java.lang.String |
VWInstructionElement.getWorkFlowNumber()
Deprecated. Gets the workflow number. |
VWWorkflowDefinition[] |
VWWorkflowCollectionDefinition.getWorkflows()
Gets the set of workflows associated with this collection. |
VWWorkflowSignature |
VWWorkflowDefinition.getWorkflowSignature()
(FileNet internal use only) Return a work class signature for this workflow definition. |
java.lang.String |
VWWorkObject.getWorkObjectName()
Returns the name of this work object. |
java.lang.String |
VWStepElement.getWorkObjectName()
Gets the work item name. |
java.lang.String |
VWRosterElement.getWorkObjectName()
Gets the name of this work object. |
java.lang.String |
VWQueueElement.getWorkObjectName()
Gets the name of this work object. |
java.lang.String |
VWInstructionElement.getWorkObjectName()
Deprecated. Gets the workflow object name. |
java.lang.String |
VWWorkObject.getWorkObjectNumber()
Returns a string version of the work object number. |
java.lang.String |
VWStepElement.getWorkObjectNumber()
Returns the work item number in string format. |
java.lang.String |
VWRosterElement.getWorkObjectNumber()
Gets the work object number (as a string). |
java.lang.String |
VWQueueElement.getWorkObjectNumber()
Gets the workflow object. |
java.lang.String |
VWLogElement.getWorkObjectNumber()
Gets the string version of the work object number. |
java.lang.String |
VWInstructionElement.getWorkObjectNumber()
Deprecated. Gets the string version of the F_WobNum(workflow object number). |
java.lang.String |
VWLogElement.getWorkObjectTag()
Gets the work object tag value. |
int |
VWWorkObject.getWorkOrderId()
Returns the work order ID associated with this work object; may be null. |
int |
VWStepElement.getWorkOrderId()
Returns the work order ID. |
int |
VWLogElement.getWorkOrderId()
Gets the authored work order ID for the instruction or step the work object was processing at the time the system logged the record. |
java.lang.String |
VWWorkObject.getWorkPerformerClassName()
Returns the name of the work performer class associated with the queue on which the work object resides. |
java.lang.String |
VWQueueElement.getWorkPerformerClassName()
Deprecated. Replaced by VWQueueElement.getQueueName()
Gets the name of the Work Performer Class associated with the
queue on which the workflow object currently resides. |
java.lang.String |
VWInstructionElement.getWorkPerformerClassName()
Deprecated. Gets the name of the Work Performer Class associated with the queue on which the workflow object currently resides. |
int |
VWStepElement.getWorkSpaceId()
Gets the ID of the work space for this work item. |
java.lang.String[] |
VWApplicationSpaceDefinition.getWriteSecurity()
Gets the users and/or groups who have write access to the application space. |
VWParticipant[] |
VWTableDefinition.getWriteSecurityPx()
Returns an array of VWParticipant objects that specifies users and/or groups who have write access. |
VWParticipant[] |
VWRosterDefinition.getWriteSecurityPx()
Returns an array of VWParticipant objects containing the names of the user and/or groups who have write access to this roster. |
VWParticipant[] |
VWQueueDefinition.getWriteSecurityPx()
Gets the VWParticipant objects for the users and/or groups having Write access to this queue. |
VWParticipant[] |
VWApplicationSpaceDefinition.getWriteSecurityPx()
Gets the VWParticipant objects specifying the users and/or groups who have write access to the application space. |
java.lang.String |
VWFieldDefinition.getXMLSchemaElement()
Get the XML Schema Element. |
java.lang.String |
VWFieldDefinition.getXMLSchemaName()
Get the XML Schema Name. |
boolean |
VWWorkObject.hasBeenAltered(java.lang.String fieldName)
Indicates whether the specified field has changed in this work object. |
boolean |
VWInstructionElement.hasBeenAltered(java.lang.String fieldName)
Deprecated. Determines whether or not the field has been modified. |
boolean |
VWLogElement.hasField(java.lang.String fieldName)
Determines whether or not the named user-defined field name exists. |
boolean |
VWWorkObject.hasFieldName(java.lang.String fieldName)
Indicates whether the specified data field exists in this work object. |
boolean |
VWTableDefinition.hasFieldName(java.lang.String fieldName)
Determine whether a specified log, queue, or roster field exists. |
boolean |
VWRosterElement.hasFieldName(java.lang.String fieldName)
Indicates whether the specified field exists. |
boolean |
VWQueueElement.hasFieldName(java.lang.String fieldName)
Indicates whether the specified field exists. |
boolean |
VWQueueDefinition.hasFieldName(java.lang.String fieldName)
Indicates whether the specified exposed field exists for this instance. |
boolean |
VWInstructionElement.hasFieldName(java.lang.String fieldName)
Deprecated. Determines whether or not the specified field exists. |
boolean |
VWWorkflowMilestones.hasNext()
Returns true if the current VWWorkflowMilestones
instance has more VWMilestoneElement object elements. |
boolean |
VWWorkflowHistory.hasNext()
Indicates whether another element can be fetched from this VWWorkflowHistory instance. |
boolean |
VWStepWorkObjectHistory.hasNext()
Indicates whether another element can be fetched from this VWStepWorkObjectHistory instance. |
boolean |
VWStepOccurrenceHistory.hasNext()
Indicates whether another element can be fetched from this VWStepOccurrenceHistory instance. |
boolean |
VWSecurityList.hasNext()
Indicates whether another element can be fetched from this VWSecurityList instance. |
boolean |
VWRosterQuery.hasNext()
Indicates whether another element can be fetched from this VWRosterQuery instance. |
boolean |
VWQueueQuery.hasNext()
Indicates whether another element can be fetched from this VWQueueQuery instance. |
boolean |
VWProcess.hasNext()
Determines whether there are more work objects to retrieve. |
boolean |
VWParticipantList.hasNext()
Indicates whether another element can be fetched from this VWParticipantList instance. |
boolean |
VWLogQuery.hasNext()
Determines whether or not more elements exist beyond the current element. |
boolean |
VWAttachmentTrackingQuery.hasNext()
Determines whether or not more roster elements exist beyond the current roster element. |
boolean |
VWStepElement.hasParameterName(java.lang.String parameterName)
Indicates whether the specified parameter exists for this instance. |
boolean |
VWRoleDefinition.hasRoleParticipantsChanged()
|
static java.lang.String |
VWXMLConfiguration.importConfiguration(VWSession session,
java.lang.String config,
int option)
Imports Process Engine administration and configuration properties from a String containing XML text representing the properties. |
static java.lang.String |
VWXMLConfiguration.importConfigurationFromFile(VWSession session,
java.lang.String inputFile,
int option)
Imports Process Engine administration and configuration properties from an XML document. |
void |
VWSystemAdministration.initializeRegion()
Initializes the current region. |
VWFieldDefinition |
VWWorkflowDefinition.insertField(VWFieldDefinition theField)
Inserts a field in this workflow definition. |
VWMapDefinition |
VWWorkflowDefinition.insertMap(VWMapDefinition theMap)
Inserts a map in this workflow definition. |
VWMilestoneDefinition |
VWWorkflowDefinition.insertMilestone(VWMilestoneDefinition theMilestone)
Inserts a milestone in this workflow definition. |
VWPartnerLinkDefinition |
VWWorkflowDefinition.insertPartnerLink(VWPartnerLinkDefinition thePartnerLink)
Inserts a partner link in this workflow definition. |
VWRuleSetDefinition |
VWWorkflowDefinition.insertRuleSet(VWRuleSetDefinition theRuleSet)
Inserts a ruleset in this workflow definition. |
VWSchema |
VWWorkflowDefinition.insertSchema(VWSchema theSchema)
Inserts a schema in this workflow definition. |
boolean |
VWWebServiceParameterDefinition.isAttachmentByValue()
Indicates whether the Process Engine will send the attachment data by value. |
boolean |
VWRosterQuery.isDone()
Deprecated. Replaced by VWRosterQuery.next() . |
boolean |
VWWorkflowCollectionDefinition.isExistingWorkflowName(java.lang.String theName)
Check to see whether a workflow definition having the specified name exists in this collection. |
boolean |
VWUserInfo.isFieldArray(java.lang.String fieldName)
Indicates whether a field is an array. |
boolean |
VWAttributeInfo.isFieldArray(java.lang.String fieldName)
Determines whether a field is an array. |
boolean |
VWSession.isMemberOfGroup(java.lang.String groupName)
Determines whether or not the logged on user is a member of a specific group. |
boolean |
VWSession.isMemberOfGroupByDomain(java.lang.String domainName,
java.lang.String groupName)
Indicates whether or not the user currently logged on is a member of the specified group in the specified domain. |
boolean |
VWWorkBasketColumnDefinition.isSortable()
Indicates whether or not the workbasket column can be sorted. |
boolean |
VWWorkBasket.Column.isSortable()
Indicates whether the workbasket column can be sorted. |
boolean |
VWRosterElement.isSystemField(java.lang.String fieldName)
Indicates whether the field specified is a system field. |
boolean |
VWQueueElement.isSystemField(java.lang.String fieldName)
Indicates whether the field specified is a system field. |
void |
VWWorkObject.lock(boolean overrideLock)
Deprecated. Replaced by VWWorkObject.doLock( boolean) |
void |
VWInstructionElement.lock(boolean overrideLock)
Deprecated. Replaced by VWInstructionElement.doLock(boolean) |
static VWException[] |
VWInstructionElement.lockMany(VWInstructionElement[] intrs,
boolean overrideLock)
Deprecated. Replaced by VWInstructionElement.doLockMany(VWInstructionElement[], boolean) |
static VWException[] |
VWWorkObject.lockMany(VWWorkObject[] wobjs,
boolean overrideLock)
Deprecated. Replaced by VWWorkObject.doLockMany(VWWorkObject[], boolean) |
void |
VWInstructionElement.logMessage(int loggingOption,
java.lang.String message)
Deprecated. Logs a message to the default server log. |
void |
VWSession.logoff()
Ends the session with the Process Engine and frees all resources. |
void |
VWSession.logon(java.lang.String url)
Logs on to an existing session in an environment where the JAAS context is already established. |
void |
VWSession.logon(java.lang.String user,
java.lang.String password,
java.lang.String connectionPointName)
Logs onto an existing session. |
void |
VWSession.logonByDomain(java.lang.String domain,
java.lang.String user,
java.lang.String password,
java.lang.String connectionPointName)
Logs on to an existing session for a specified domain. |
void |
VWSession.logonWithToken(java.lang.String theToken,
java.lang.String connectionPointName)
For FileNet Web Services and Open Client only, this method can establish a shared logon session. |
static int |
VWFieldType.lValue(java.lang.String theExpr,
VWWorkflowSignature theSig,
VWWorkflowDefinition theWF)
Determines whether an expression is a valid as an array or single value on the left (target) side of an assignment statement. |
static java.lang.String |
VWXMLUtil.makeXMLBlock(IVWtoXML apiObject)
Creates XML header information and XML text representing runtime a Process Engine API object from a runtime Process Engine API object that implements the IVWtoXML interface. |
static java.lang.String |
VWXMLConfiguration.makeXMLBlock(IVWtoXML[] apiObjects)
Creates XML header information and XML text representing the specified administration and configuration objects implementing the IVWtoXML interface. |
static java.lang.String |
VWXMLUtil.makeXMLBlock(IVWtoXML[] apiObjects,
java.lang.String theGroupTag)
Creates XML header information and XML text representing runtime Process Engine API objects in an input array of runtime Process Engine API objects that implement the IVWtoXML interface. |
VWMilestoneElement |
VWWorkflowMilestones.next()
Returns the next element in an iterated series of VWMilestoneElement members that belong to the current instance of the VWWorkflowMilestones class. |
VWStepHistory |
VWWorkflowHistory.next()
Retrieves the subsequent element for this VWWorkflowHistory instance. |
VWParticipantHistory |
VWStepWorkObjectHistory.next()
Retrieves the subsequent element for this VWStepWorkObjectHistory instance. |
VWStepWorkObjectHistory |
VWStepOccurrenceHistory.next()
Retrieves the subsequent element for this VWStepOccurrenceHistory instance. |
VWStepOccurrenceHistory |
VWStepHistory.next()
Retrieves the subsequent element for this VWStepHistory instance. |
java.lang.Object |
VWSecurityList.next()
Retrieves the subsequent element for the current VWSecurityList instance. |
java.lang.Object |
VWRosterQuery.next()
Retrieves the subsequent element for this VWRosterQuery instance. |
java.lang.Object |
VWQueueQuery.next()
Retrieves the subsequent element for this VWQueueQuery instance. |
VWWorkObject |
VWProcess.next()
Retrieves the subsequent work object in the series of active work objects associated with this process. |
java.lang.Object |
VWParticipantList.next()
Retrieves the subsequent element for the current VWParticipantList instance. |
VWLogElement |
VWLogQuery.next()
Gets the next log element in the collection (if one exists). |
VWRosterElement |
VWAttachmentTrackingQuery.next()
Gets the next roster element from the results of the "referencing attachment" query. |
void |
VWMapDefinition.normalize()
Ensures that the start step (the step having an ID of zero) is the first step in this map. |
static int |
VWActionType.numberOfParameters(int actionType)
Gets the number of parameters required for an action. |
static VWExposedFieldDefinition[] |
VWRosterDefinition.optionalSystemFields()
Returns workflow system exposed fields that are marked as optional. |
static VWExposedFieldDefinition[] |
VWQueueDefinition.optionalSystemFields()
Gets definitions of optional exposed queue fields. |
static VWExposedFieldDefinition[] |
VWLogDefinition.optionalSystemFields()
Returns workflow system exposed fields, which are marked as optional. |
static VWExposedFieldDefinition[] |
VWTableDefinition.optionalSystemFields(int theType)
Gets optional exposed workflow system fields of type roster, queue, or log. |
IVWPastable[] |
VWMapDefinition.paste(java.lang.String thePaste)
Pastes steps and text annotations into the workflow definition. |
VWMapNode[] |
VWStepPaletteDefinition.pasteSteps(java.lang.String xmlStepdefs)
Pastes steps into the step palette definition. |
VWMapNode[] |
VWMapDefinition.pasteSteps(java.lang.String thePaste)
Deprecated. use the IVWPastable paste(String) method instead. This method was deprecated because we can now paste VWTextAnnotations in addition to the VWMapNodes. This method may fail if it is used to paste an XML string that contains anything other than steps (i.e. classes that inherit from VWMapNode). Pastes steps into the workflow definition. The step definitions are contained in an XML-formatted string. |
static VWWorkflowDefinition |
VWWorkflowDefinition.read(java.io.InputStream theStream)
Evaluates a workflow definition from an input stream. |
static VWWorkflowCollectionDefinition |
VWWorkflowCollectionDefinition.read(java.io.InputStream theStream)
Evaluates and creates a workflow collection based on the values read from a specified input stream. |
static VWStepPaletteDefinition |
VWStepPaletteDefinition.read(java.io.InputStream theStream)
Creates the new VWStepPaletteDefinition using values it reads from the input stream. |
static VWWorkflowDefinition |
VWWorkflowDefinition.readFromFile(java.lang.String theFileName)
Evaluates a workflow definition from a file. |
static VWWorkflowCollectionDefinition |
VWWorkflowCollectionDefinition.readFromFile(java.lang.String theFileName)
Evaluates and creates a workflow collection based on the values read from a specified file. |
static VWStepPaletteDefinition |
VWStepPaletteDefinition.readFromFile(java.lang.String theFileName)
Creates the new VWStepPaletteDefinition using values read from the named file. |
boolean |
VWSession.recoverUser(java.lang.String userName,
java.lang.String[] queueNames)
Recovers a user, given a list of queue names like the list produced by fetchQueueNames . |
void |
VWWorkObject.refresh(boolean lock,
boolean overrideLock)
Deprecated. Replaced by VWWorkObject.doRefresh(boolean, boolean) |
void |
VWInstructionElement.refresh(boolean lock,
boolean overrideLock)
Deprecated. Replaced by VWInstructionElement.doRefresh(boolean, boolean) |
void |
VWSystemAdministration.removeAllRegions()
Deletes information for all isolated regions. |
void |
VWSystemAdministration.removeLinkFlag(java.lang.String theDocument)
Deletes the linked-document indicator from a transferred work space. |
void |
VWSystemAdministration.removeRegion()
Deletes the current isolated region and information that pertains to it. |
VWWorkflowDefinition |
VWWorkflowCollectionDefinition.removeWorkflow(java.lang.String theWorkflowName)
Removes the specified workflow from this collection. |
void |
VWSystemAdministration.removeWorkflowDatabase()
Deletes all workflow information from the database. |
void |
VWMapNode.reorderRoutes(int[] theRouteOrder)
Changes the order in which the system stores outbound routes in this map node. |
void |
VWStepWorkObjectHistory.resetFetch()
Resets the last element fetched for this step history object. |
void |
VWStepOccurrenceHistory.resetFetch()
Resets the last element fetched for this step history object. |
void |
VWWorkObject.save()
Deprecated. Replaced by VWWorkObject.doSave(boolean) |
void |
VWUserInfo.save()
Saves the values set for this instance. |
void |
VWInstructionElement.save()
Deprecated. Replaced by VWInstructionElement.doSave(boolean) |
static VWException[] |
VWInstructionElement.saveMany(VWInstructionElement[] invs)
Deprecated. Replaced by VWInstructionElement.doSaveMany(VWInstructionElement[]) |
static VWException[] |
VWWorkObject.saveMany(VWWorkObject[] workObjects)
Deprecated. Replaced by VWWorkObject.doSaveMany(VWWorkObject[]) |
void |
VWStepProcessorInfoDefinition.setApplicationName(java.lang.String theApplicationName)
Sets the application name. |
void |
VWStepProcessorInfoDefinition.setAppType(int theAppType)
Sets the application type associated with this step processor's information. |
void |
VWWebServiceParameterDefinition.setArrayAttributes(java.lang.String arrayAttributes)
Sets the attributes for an array specified by array tag and array namespace, for this parameter. |
void |
VWWebServiceParameterDefinition.setArrayNameSpace(java.lang.String arrayNameSpace)
Sets the namespace for an array tag for this parameter; may be null . |
void |
VWWebServiceParameterDefinition.setArrayTag(java.lang.String arrayTag)
Sets the array tag name for this parameter |
void |
VWEventDefinition.setAssignments(java.lang.String[][] theAssignments)
Sets the assignments property value for the event. |
void |
VWWebServiceParameterDefinition.setAttachmentByValue(boolean setting)
Specifies whether the Process Engine will send the attachment data by value. |
void |
VWAttachment.setAttachmentDescription(java.lang.String theAttachmentDescription)
Sets the description for an attachment. |
void |
VWAttachment.setAttachmentName(java.lang.String theAttachmentName)
Sets the document name for this attachment. |
void |
VWWorkflowDefinition.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets a VWAttribute object containing attributes for this object. |
void |
VWWorkBasketFilterDefinition.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets the attributes property value for the work basket filter definition. |
void |
VWWorkBasketDefinition.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets the attributes property value for the work basket definition. |
void |
VWWorkBasketColumnDefinition.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets the attributes property value for the workbasket column definition. |
void |
VWSystemConfiguration.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets a VWAttribute object containing attributes for this object. |
void |
VWSystemAdministration.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets a VWAttribute object containing attributes for this object. |
void |
VWRouteDefinition.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets a VWAttribute object containing attributes for this object. |
void |
VWRoleDefinition.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets the attributes property value for the role definition. |
void |
VWQueueDefinition.setAttributeInfo(VWAttributeInfo theAttributes)
Sets the attributes for this instance. |
void |
VWOperationDefinition.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets a VWAttribute object containing attributes for this object. |
void |
VWMapNode.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets a VWAttribute object containing attributes for this object. |
void |
VWApplicationSpaceDefinition.setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets the attributes property value for the application space. |
void |
VWWebServiceParameterDefinition.setAttributes(java.lang.String attributes)
Sets the attributes for this parameter, as they are applied to this combination of namespace and parameter name. |
void |
VWReceiveInstruction.setAuthentication(boolean theAuthenticationFlag)
Sets the value of theAuthenticationFlag, indicating a Web Service security header authenticating the caller is to be used for this operation. |
void |
VWWorkflowDefinition.setAuthorTool(java.lang.String theAuthorTool)
Changes the value of this workflow definition's authorTool property. |
void |
VWWorkflowCollectionDefinition.setAuthorTool(java.lang.String theAuthorTool)
Specifies the identifier for the application that generated this instance. |
void |
VWWorkflowDefinition.setBaseWorkClassName(java.lang.String theBaseWorkClassName)
Changes the value of this workflow definition's base work class name. |
void |
VWWorkflowHistory.setBufferSize(int newSize)
Changes the maximum number of elements to return in a fetch. |
void |
VWStepWorkObjectHistory.setBufferSize(int newSize)
Sets the maximum number of elements to return in a fetch. |
void |
VWStepOccurrenceHistory.setBufferSize(int newSize)
Sets the maximum number of elements to return in a fetch. |
void |
VWStepHistory.setBufferSize(int newSize)
Sets the maximum number of elements to return in a fetch. |
void |
VWRoster.setBufferSize(int newSize)
Sets the integer value for the maximum number of elements to return in a fetch. |
void |
VWQueue.setBufferSize(int theNewSize)
Sets the maximum number of elements to return in a fetch. |
void |
VWProcess.setBufferSize(int newSize)
Sets the maximum number of elements to return in a fetch. |
void |
VWLog.setBufferSize(int theNewSize)
Sets the maximum number of elements to return in a fetch. |
void |
VWEventDefinition.setCallISName(java.lang.String theCallISName)
Changes the value of this event's instruction sheet call property. |
void |
VWWorkObject.setCallMap(java.lang.String aMapName)
Specifies a map to be called when this work object is dispatched. |
void |
VWStepElement.setCallMap(java.lang.String aMapName)
Specifies a map to be called when the system dispatches this work object. |
void |
VWInvokeInstruction.setCatchAllMap(java.lang.String theMapName)
Sets the general fault-handling (catch all) map name. |
void |
VWInvokeInstruction.setCatchAllOutput(java.lang.String theOutput)
Sets the general fault-handling (catch all) output expression that will hold the fault information. |
void |
VWSession.setClientLocale(java.util.Locale myLocale)
Sets the client locale to be used when translating to a language other than the default language of the Process Engine server. |
void |
VWWorkBasketColumnDefinition.setColumn(VWExposedFieldDefinition column)
Gets the VWExposedFieldDefinition for the workbasket column definition. |
void |
VWStepElement.setComment(java.lang.String comment)
Sets the comment for this instance. |
void |
VWEventDefinition.setComparisonOperator(java.lang.String theOperator)
Changes the value of this event's comparison operator. |
void |
VWRollbackInstruction.setCompCall(java.lang.String theCompCallIS)
Initialize or modify the name of the compensation call instruction sheet for this rollback instruction. |
void |
VWReceiveInstruction.setCorrelationParameterSequenceNumber(int theParamSeqNumber)
Sets the correlation parameter sequence number of this receive instruction; may be -1, indicating there is no correlation parameter. |
void |
VWReplyInstruction.setCorrelationSetName(java.lang.String theName)
Sets the correlation set name. |
void |
VWReceiveInstruction.setCorrelationSetName(java.lang.String theName)
Sets the correlation set name; may be null. |
void |
VWReplyInstruction.setCorrelationSetProperties(java.lang.String[][] theProps)
Sets the output correlation set properties for this reply message. |
void |
VWReceiveInstruction.setCorrelationSetProperties(java.lang.String[][] theProps)
Sets the output correlation set properties. |
void |
VWReceiveInstruction.setCorrelationValueExpression(java.lang.String theValueExpr)
Sets an expression that evaluates to the correlation set parameter value for this receive instruction; may be null. |
void |
VWRosterDefinition.setCreateSecurity(java.lang.String[] theNames)
Sets create access to the roster for the passed-in list of users and/or groups. |
void |
VWRosterDefinition.setCreateSecurityPx(VWParticipant[] thePxList)
Sets create access on the roster for the users and/or groups specified by the passed-in array of VWParticipant objects. |
void |
VWWorkObject.setDataFields(VWDataField[] dataFields,
boolean compareValues)
Changes the values for specified data fields. |
void |
VWWebServiceParameterDefinition.setDataType(int theDataType)
Sets the field data type . |
void |
VWParameterDefinition.setDataType(int theDataType)
Sets the data type for the parameter. |
static void |
VWXMLUtil.setDatePattern(java.lang.String pattern)
Sets the date pattern format for runtime toXML methods, such as VWQueueElement.toXML(StringBuffer) . |
static void |
VWXMLUtil.setDateTimeZone(java.util.SimpleTimeZone TZone)
Sets the SimpleTimeZone used to format dates in runtime toXML methods, such as VWQueueElement.toXML(StringBuffer) . |
void |
VWWorkflowDefinition.setDeadline(long theDeadline)
Changes the deadline property for this workflow definition. |
void |
VWStepDefinition.setDeadline(long theDeadline)
Sets the deadline for this step. |
void |
VWStepDefinition.setDeadlineExpr(java.lang.String theDeadlineExpr)
Sets the value of the deadline expression property for this step definition. |
void |
VWStepProcessorInfoDefinition.setDefaultType(int theDefaultType)
Sets the step processor default type. |
void |
VWSession.setDefaultWebApplication(int theWebApplicationId)
Sets the default Web Application ID
for a logged-on session; the default web application is applied
to an initial transfer to a region. |
void |
VWWorkBasketFilterDefinition.setDescription(java.lang.String description)
Sets the description to use for the work basket filter definition. |
void |
VWWorkBasketDefinition.setDescription(java.lang.String description)
Sets the description of the work basket definition. |
void |
VWRoleDefinition.setDescription(java.lang.String description)
Sets the role definition description. |
void |
VWOperationDefinition.setDescription(java.lang.String theDescription)
Sets the description of this operation. |
void |
VWApplicationSpaceDefinition.setDescription(java.lang.String description)
Sets the application space description. |
void |
VWRouteDefinition.setDestinationStepId(int theDestinationStepId)
Sets the integer value of the stepId property for the step destination. |
void |
VWXMLData.setElementName(java.lang.String theNewElementName)
Sets the element name. |
void |
VWUserInfo.setEMailAddress(java.lang.String theEMailAddress)
Sets the email address for the current user. |
void |
VWWorkflowDefinition.setEventLogName(java.lang.String theEventLogName)
Changes the event log name for this workflow definition. |
void |
VWWFEInstruction.setEventNumLoc(java.lang.String theEventNumLoc)
Change the value of this instruction's eventNumLoc expression property. |
void |
VWWFEInstruction.setEvents(VWEventDefinition[] theEvents)
Sets the events contained in this VWWFEInstruction instance. |
void |
VWWorkObject.setException(java.lang.String aInstructionSheetName,
java.lang.String aDescription)
Sets a Process Engine exception condition (not a Java exception) for this work object. |
void |
VWStepElement.setException(java.lang.String workflowMapName,
java.lang.String description)
Sets an exception condition for the workflow map associated with this instance. |
void |
VWInstructionElement.setException(java.lang.String anInstructionSheetName,
java.lang.String aDescription)
Deprecated. Sets a exception condition for the workflow object specified by the Instruction Element. |
void |
VWRuleSetDefinition.setExpensive(boolean expensive)
Permits asynchronous execution of this instance. |
void |
VWReplyInstruction.setFaultName(java.lang.String theName)
Creates a fault in this VWReplyInstruction instance. |
void |
VWInvokeInstruction.setFaults(VWFaultDefinition[] theFaults)
Sets the faults contained in this instance. |
void |
VWIndexDefinition.setFieldNames(java.lang.String[] theFieldNames)
Sets the index definition to the specified field names. |
void |
VWWorkflowSignature.setFields(VWFieldDefinition[] theFields)
Set the fields in the signature. |
void |
VWWorkObject.setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Deprecated. Replaced by VWWorkObject.setFieldValue(String, Object, boolean) |
void |
VWUserInfo.setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Creates, deletes, or updates a field for this instance. |
void |
VWInstructionElement.setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Deprecated. Sets a value for the specified field. |
void |
VWAttributeInfo.setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Initializes, updates, or deletes an attribute. |
void |
VWWorkObject.setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue,
boolean compareValue)
Changes the value of a specified data field in this work object. |
void |
VWReplyInstruction.setHasAttachments(boolean theHasAttachmentsFlag)
Sets the HasAttachments flag, indicating whether the message is associated with one or more attachments. |
void |
VWStepProcessorInfoDefinition.setHeight(int theHeight)
Sets the height of the step processor. |
void |
VWRoleDefinition.setHomePageURL(java.lang.String homePageURL)
Sets the URL of the home page for the role definition. |
void |
VWAttachment.setId(java.lang.String theId)
Sets the document ID associated with the attachment. |
void |
VWWorkflowDefinition.setIncomingWSAttachmentFolder(java.lang.String inAttachmentFolder)
Specifies a folder that will be used to store incoming Web Services attachments that are available through a receive instruction. |
void |
VWWorkBasketDefinition.setIndexName(java.lang.String indexName)
Sets the search index to use. |
void |
VWWorkBasketColumnDefinition.setIndexName(java.lang.String indexName)
|
void |
VWInvokeInstruction.setInputCorrelationSetName(java.lang.String theName)
Sets the input correlation set name for this instance. |
void |
VWInvokeInstruction.setInputCorrelationSetProperties(java.lang.String[][] theProps)
Sets the input correlation set properties for this instance. |
void |
VWInvokeInstruction.setInputMsgExpr(java.lang.String theInputMsgExpr)
Sets the input message expression for this instance. |
void |
VWInvokeInstruction.setInputMsgName(java.lang.String theInputMsgName)
Sets the input message name for this instance. |
void |
VWCompoundStepDefinition.setInstructions(VWInstructionDefinition[] theInstructions)
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. |
void |
VWWebServiceParameterDefinition.setIsArray(boolean theIsArray)
Sets the isArray flag on the parameter, specifying whether the parameter is an array. |
void |
VWMapNode.setJoinType(int theJoinType)
Sets the value of this step's JoinType property. |
void |
VWExposedFieldDefinition.setLength(int theLength)
Sets the byte length of string data to be stored in the search data field. |
void |
VWMilestoneDefinition.setLevel(int theLevel)
Sets the level for the milestone. |
void |
VWWebServiceParameterDefinition.setLexicalLevel(int level)
Sets the level of nesting (containment) for this parameter. |
void |
VWAttachment.setLibraryName(java.lang.String theLibraryName)
Sets the name of the library or object store associated with this attachment. |
void |
VWAttachment.setLibraryType(int theLibraryType)
Sets the library or object store type for the library or object store containing this attachment. |
void |
VWTextAnnotationDefinition.setLocation(java.awt.Point location)
Sets the value of the location property associated with this annotation. |
void |
VWStepProcessorInfoDefinition.setLocation(java.lang.String theLocation)
Deprecated. Replaced by VWStepProcessorInfoDefinition.setLocations(Hashtable) . |
void |
VWStepProcessorInfoDefinition.setLocations(java.util.Hashtable theLocations)
Sets the URL locations associated with this step processor, for each web application. |
int |
VWSystemConfiguration.setLoggingState(int newLoggingOptions,
boolean turnOn)
Enables or disables system logging options. |
void |
VWWorkflowDefinition.setMainAttachmentName(java.lang.String theName)
Modifies the main attachment name property of this workflow definition. |
void |
VWWorkflowCollectionDefinition.setMainWorkflowByName(java.lang.String theName)
Specifies the the main workflow in this collection. |
void |
VWFieldDefinition.setMergeType(int theMergeType)
Modifies the merge type property for the data field. |
void |
VWTextAnnotationDefinition.setMessage(java.lang.String message)
Sets the value of the message property associated with this annotation. |
void |
VWMilestoneDefinition.setMessage(java.lang.String theMessage)
Sets the message for the milestone. |
void |
VWReplyInstruction.setMessageExpr(java.lang.String theMessageExpr)
Sets the message expression of this reply instruction. |
void |
VWReceiveInstruction.setMessageExpr(java.lang.String theMsgExpr)
Sets the message expression of this receive instruction. |
void |
VWReplyInstruction.setMessageFromElementName(java.lang.String theElement)
Sets the name of the schema element that defines the WSDL message associated with this reply message, where the schema is defined in the containing workflow definition. |
void |
VWReceiveInstruction.setMessageFromElementName(java.lang.String theElement)
Sets the name of the schema element that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition. |
void |
VWReplyInstruction.setMessageFromSchemaName(java.lang.String theSchemaName)
Sets the name of the schema that defines the WSDL message associated with this reply message, where the schema is defined in the containing workflow definition. |
void |
VWReceiveInstruction.setMessageFromSchemaName(java.lang.String theSchema)
Sets the name of the schema that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition. |
void |
VWWorkflowDefinition.setMilestones(VWMilestoneDefinition[] theMilestones)
Replaces or reorders the array of milestones for this workflow definition, without adding or deleting milestones. |
void |
VWParameterDefinition.setMode(int theMode)
Sets the mode for the parameter. |
void |
VWPartnerLinkDefinition.setMyPortType(java.lang.String theMyPortType)
Sets the MyportType of this partner link. |
void |
VWPartnerLinkDefinition.setMyRole(java.lang.String theMyRole)
Sets the MyRole of this partner link. |
void |
VWWorkflowDefinition.setName(java.lang.String theName)
Changes the name property for this workflow definition. |
void |
VWWorkflowCollectionDefinition.setName(java.lang.String theName)
Changes the name of this instance. |
void |
VWWorkBasketFilterDefinition.setName(java.lang.String theName)
Sets the name for the work basket filter definition. |
void |
VWWorkBasketDefinition.setName(java.lang.String theName)
Sets the name of the work basket definition. |
void |
VWWebServiceParameterDefinition.setName(java.lang.String theName)
Renames this parameter. |
void |
VWUserInfo.setName(java.lang.String theUserName)
Deprecated. VWUserInfo records are created on the server, the name cannot be changed |
void |
VWTextAnnotationDefinition.setName(java.lang.String name)
Sets the value of the name property associated with this annotation. |
void |
VWStepProcessorInfoDefinition.setName(java.lang.String theName)
Sets the name associated with this step processor's information object. |
void |
VWSchema.setName(java.lang.String theName)
Sets the name of this schema. |
void |
VWRuleSetDefinition.setName(java.lang.String theName)
Sets the name for this instance. |
void |
VWRoleDefinition.setName(java.lang.String theName)
Sets the role definition name. |
void |
VWPartnerLinkDefinition.setName(java.lang.String theName)
Sets the name of this partner link. |
void |
VWParameterDefinition.setName(java.lang.String theName)
Renames this parameter. |
void |
VWOperationDefinition.setName(java.lang.String theName)
Sets the name of this operation. |
void |
VWMilestoneDefinition.setName(java.lang.String theName)
Sets the name for the milestone. |
void |
VWMapNode.setName(java.lang.String theName)
Sets the value of the current node's name property. |
void |
VWMapDefinition.setName(java.lang.String theName)
Sets the name for this map. |
void |
VWFieldDefinition.setName(java.lang.String theName)
Changes the data field name property. |
void |
VWFaultDefinition.setName(java.lang.String theName)
Sets the name of this fault definition, which must be unique (within the containing invoke instruction), non- null , and non-empty. |
void |
VWAssociationDefinition.setName(java.lang.String name)
Sets the name of this association. |
void |
VWWebServiceParameterDefinition.setNameSpace(java.lang.String nameSpace)
Sets the namespace for this parameter. |
void |
VWUserInfo.setNotificationFlags(int theFlags)
Sets the notification flag settings for this instance. |
void |
VWReplyInstruction.setOperationName(java.lang.String theOperationName)
Sets the operation name of this reply instruction, which must be the name of an operation on the port type defined in the associated partner link. |
void |
VWReceiveInstruction.setOperationName(java.lang.String theOperationName)
Sets the operation name of this receive instruction, which must be the name of an operation on the port type defined in the associated partner link. |
void |
VWInvokeInstruction.setOperationName(java.lang.String theOperationName)
Sets the operation name for this instance. |
void |
VWWorkBasketFilterDefinition.setOperator(int op)
Sets the operator applied to the search field used for filtering. |
void |
VWInvokeInstruction.setOutputCorrelationSetName(java.lang.String theName)
Sets the output correlation set name for this instance. |
void |
VWInvokeInstruction.setOutputCorrelationSetProperties(java.lang.String[][] theProps)
Sets the output correlation set properties for this instance. |
void |
VWInvokeInstruction.setOutputMsgExpr(java.lang.String theOutputMsgExpr)
Sets the output message expression for this instance. |
void |
VWInvokeInstruction.setOutputMsgName(java.lang.String theOutputMsgName)
Sets the output message name for this instance. |
void |
VWStepElement.setParameters(VWParameter[] parameters,
boolean compareValues)
Sets the values for specified parameters for this instance. |
void |
VWStepElement.setParameterValue(java.lang.String parameterName,
java.lang.Object parameterValue,
boolean compareValue)
Sets a value for a specified parameter in this instance. |
void |
VWSimpleInstruction.setParams(java.lang.String[] theParams)
Changes the value of this instruction's params property. |
void |
VWRollbackInstruction.setParams(java.lang.String[] theParams)
Initialize or modify the parameters of this instruction. |
void |
VWPartnerLinkDefinition.setPartnerEndPoint(java.lang.String thePartnerEndPoint)
Sets the end point of this partner link. |
void |
VWReplyInstruction.setPartnerLinkName(java.lang.String thePartnerLinkName)
Sets the partner link name of this reply instruction. |
void |
VWReceiveInstruction.setPartnerLinkName(java.lang.String thePartnerLinkName)
Sets the partner link name of this receive instruction. |
void |
VWInvokeInstruction.setPartnerLinkName(java.lang.String thePartnerLinkName)
Sets the partner link name for this instance. |
void |
VWWorkflowDefinition.setPartnerLinks(VWPartnerLinkDefinition[] ThePartnerLinks)
Replaces or reorders the array of partner links for this workflow definition, without adding or deleting partner links. |
void |
VWPartnerLinkDefinition.setPartnerPortType(java.lang.String thePartnerPortType)
Sets the port type of this partner link. |
void |
VWPartnerLinkDefinition.setPartnerRole(java.lang.String thePartnerRole)
Sets the partner role of this partner link. |
void |
VWStepDefinition.setPostAssignments(java.lang.String[][] thePostAssignments)
Defines the field values to be performed after the step is processed. |
void |
VWStepDefinition.setPostMilestone(java.lang.String mileStoneName)
Sets 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. |
void |
VWStepDefinition.setPreAssignments(java.lang.String[][] thePreAssignments)
Defines the field values to be performed before the step is processed. |
void |
VWUserInfo.setPreferredLocale(java.util.Locale myLocale)
Sets the preferred locale to be used for client email notification. |
void |
VWStepDefinition.setPreMilestone(java.lang.String mileStoneName)
Sets 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. |
void |
VWStepProcessorInfoDefinition.setProcessorType(int theProcessorType)
Sets the processorType associated with this step processor's information. |
void |
VWSession.setProductId(int theProductId)
Deprecated. Replaced by VWSession.setDefaultWebApplication(int) |
void |
VWWorkBasketFilterDefinition.setPrompt(java.lang.String label)
Sets the prompt to use for the work basket filter definition. |
void |
VWWorkBasketColumnDefinition.setPrompt(java.lang.String thePrompt)
Sets the name for the workbasket column definition. |
void |
VWUserInfo.setProxyUserName(java.lang.String theUserName)
Sets the proxy user name for this instance, within the default domain. |
void |
VWUserInfo.setProxyUserNameByDomain(java.lang.String theDomainName,
java.lang.String theUserName)
Sets the proxy user name for this user information object. |
void |
VWWorkBasketDefinition.setQueryFilterString(java.lang.String queryFilter)
Sets the queue query filter string. |
void |
VWRosterDefinition.setReadSecurity(java.lang.String[] theNames)
Sets read access on the roster for the passed-in list of users and/or groups. |
void |
VWQueueDefinition.setReadSecurity(java.lang.String[] theNames)
Sets Read access to the current queue for the users and/or groups specified in the String array. |
void |
VWRosterDefinition.setReadSecurityPx(VWParticipant[] thePxList)
Sets read access privilege on this roster for the users and/or groups represented by the passed-in array of VWParticipant objects. |
void |
VWQueueDefinition.setReadSecurityPx(VWParticipant[] thePxList)
Sets Read access to the current queue for the users and/or groups referenced by the VWParticipant objects specified. |
void |
VWApplicationSpaceDefinition.setReadSecurityPx(VWParticipant[] newReadSecurityPx)
Deprecated. |
void |
VWRollbackInstruction.setReDo(java.lang.String theReDoExpr)
Initialize or modify this rollback instruction's re-do expression. |
void |
VWWorkflowDefinition.setReminder(long theReminder)
Changes the reminder property for this workflow definition. |
void |
VWStepDefinition.setReminder(long theReminder)
Sets the reminder value for the step. |
void |
VWRoleDefinition.setRoleParticipants(VWParticipant[] members)
Sets the members (users and/or groups) of this role definition. |
void |
VWWorkflowDefinition.setRosterName(java.lang.String theRosterName)
Changes the roster name for this workflow definition. |
void |
VWMapNode.setRuleSets(int ruleSetSelector,
java.lang.String[] theStringRules)
Sets the rulesets for this step definition. |
void |
VWMapNode.setRuleSets(int ruleSetSelector,
VWRuleSetDefinition[] theRules)
Deprecated. Use setRuleSets() instead. With the inheritence of rulesets from parent workflows, rules on a step should be set using an array of strings (the ruleset names), instead of an array of ruleset definitions. For backward compatibility this method will continue to accept an array of VWRuleSetDefinition objects, but only the name (returned by VWRuleSetDefinition.getValue() ) will be used. |
void |
VWCompoundStepDefinition.setRuleSets(int ruleSetSelector,
VWRuleSetDefinition[] theRules)
Sets the rule set (VWRuleSetDefinitions) to use for this instance. |
void |
VWXMLData.setSchemaName(java.lang.String theNewSchemaName)
Sets the schema name. |
void |
VWWorkflowDefinition.setSchemas(VWSchema[] TheSchemas)
Replaces or reorders the array of schemas for this workflow definition, without adding or deleting schemas. |
void |
VWWebServiceParameterDefinition.setSchemaSubType(int schemaSubType)
Sets the schema sub type for this parameter. |
void |
VWWorkBasketFilterDefinition.setSearchField(VWExposedFieldDefinition field,
int operator)
Sets the search field used for filtering. |
void |
VWReceiveInstruction.setSecurityGroup(java.lang.String[] theSecurityGroup)
Sets the security group to use for this receive instruction. |
void |
VWWorkObject.setSelectedResponse(java.lang.String response)
Changes the selected (default) response for this work object. |
void |
VWStepElement.setSelectedResponse(java.lang.String response)
Specifies a selected response for this step. |
void |
VWWebServiceParameterDefinition.setSequenceNumber(int seq)
Sets the unique sequence number for this parameter. |
void |
VWUserInfo.setServerAssignment(int theServerId)
Deprecated. BPM 4.0 release farming does not support multiple servers |
void |
VWTableDefinition.setServerId(int theNewServerId)
Set the server ID location for one of the following: log, queue, or roster. |
void |
VWRosterDefinition.setServerId(int theNewServerId)
Sets the home server ID of the roster. |
void |
VWQueueDefinition.setServerId(int theNewServerId)
Sets the server ID for the queue. |
void |
VWSystemAdministration.setSessionTimeOut(int theSessionTimeOut)
Sets the number of minutes used for all client/server sessions. |
void |
VWRouteDefinition.setSourceStepId(int theSourceStepId)
Sets the integer value of the stepId property for the step source. |
void |
VWMapNode.setSplitType(int theSplitType)
Sets the value of this step's SplitType property. |
void |
VWSystemAdministration.setStatisticsConsolidationInterval(int theInterval)
Sets the interval (minutes) between updates to the domain-wide statistics stored in the database. |
void |
VWSystemAdministration.setStatisticsSnapshotInterval(int theInterval)
Deprecated. Not replaced |
void |
VWSystemAdministration.setSystemFlags(int theFlags)
Sets the system-wide configuration flags. |
void |
VWSystemAdministration.setSystemWideFlags(int theFlags)
Deprecated. Replaced by VWSystemAdministration.setSystemFlags(int) , which requires
VWSystemAdministration.commit() to save the flag values to the workflow
server. This deprecated method saved the flag values
automatically. |
void |
VWWFEInstruction.setTimeOut(java.lang.String theTimeOut)
Change the value of this instruction's timeOut expression property. |
void |
VWReceiveInstruction.setTimeoutExpr(java.lang.String theTimeoutExpr)
Sets the timeout expression of this receive instruction; must be a valid time expression. |
void |
VWInvokeInstruction.setTimeoutExpr(java.lang.String theTimeoutExpr)
Sets the timeout expression for this instance. |
void |
VWReceiveInstruction.setTimeoutMapName(java.lang.String theTimeoutMapName)
Sets the timeout map name of this receive instruction. |
void |
VWInvokeInstruction.setTimeoutMapName(java.lang.String theTimeoutMapName)
Sets the timeout map name for this instance. |
void |
VWAttachment.setType(int theAttachmentType)
Sets the attachment type value for the associated attachment. |
void |
VWInvokeInstruction.setUseReliableMessaging(boolean theUseReliableMessagingFlag)
Specifies that reliable messaging (the WS-ReliableMessaging protocol) is to be used for this invoke instruction. |
void |
VWParameter.setValue(java.lang.Object theValue)
Sets the value of this parameter, which is of one of the VWFieldType types. |
void |
VWFieldDefinition.setValue(java.lang.Object theValue)
Modifies the value of the field, ensuring that the field type of this field definition matches the field type of the input value. |
void |
VWDataField.setValue(java.lang.Object newValue)
Sets the value of data contained in an editable field. |
void |
IVWField.setValue(java.lang.Object theValue)
Set the value of the field unless it is a read-only or system field. |
void |
VWWebServiceParameterDefinition.setValue(java.lang.String theValue)
Modifies the parameter value. |
void |
VWRuleSetDefinition.setValue(java.lang.String theValue)
Deprecated. Use #setName() instead. This method calls setName() internally and will continue to work as expected. This method has been deprecated because the property termed "value" is more correctly represented by "name" in the current implementation. |
void |
VWParameterDefinition.setValue(java.lang.String theValue)
Modifies the parameter value. |
void |
VWEventDefinition.setValue(java.lang.String theValue)
Changes the value of this event's value expression property. |
void |
VWFieldDefinition.setValue(java.lang.String theValue,
int theType,
boolean theIsArray)
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. |
void |
VWAttachment.setVersion(java.lang.String theVersion)
Sets the GUID for the attachment version for this attachment document. |
void |
VWStepProcessorInfoDefinition.setWidth(int theWidth)
Sets the width associated with this step processor's information. |
void |
VWWorkBasketDefinition.setWorkBasketColumnDefinitions(VWWorkBasketColumnDefinition[] workBasketColumnDefs)
Sets the work basket column definitions for the work basket definition. |
void |
VWRoleDefinition.setWorkBasketDefinitions(VWWorkBasketDefinition[] workBasketDefs)
Sets the workbasket definitions for this role definition. |
void |
VWWorkBasketDefinition.setWorkBasketFilterDefinitions(VWWorkBasketFilterDefinition[] workBasketFilterDefs)
Sets the work basket filter definitions for this work basket definition. |
void |
VWEventDefinition.setWorkClassName(java.lang.String theWorkClassName)
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. |
void |
VWRosterDefinition.setWriteSecurity(java.lang.String[] theNames)
Sets write access to this roster for the users and/or groups specified by an input list. |
void |
VWQueueDefinition.setWriteSecurity(java.lang.String[] theNames)
Sets Write access to the current queue for the users and/or groups specified in the String array. |
void |
VWRosterDefinition.setWriteSecurityPx(VWParticipant[] thePxList)
Sets write access to the current roster for the users and / or groups specified by the passed-in array of VWParticipant objects. |
void |
VWQueueDefinition.setWriteSecurityPx(VWParticipant[] thePxList)
Sets Write access to the current queue for the users and/or groups referenced by the VWParticipant objects specified. |
void |
VWApplicationSpaceDefinition.setWriteSecurityPx(VWParticipant[] newWriteSecurityPx)
Sets the Write access for this object. |
void |
VWXMLData.setXML(java.lang.String theNewXML)
Sets the XML string |
void |
VWFieldDefinition.setXMLSchemaElement(java.lang.String theSchemaElement)
Set the XML Schema Element. |
void |
VWFieldDefinition.setXMLSchemaName(java.lang.String theSchemaName)
Set the XML Schema Name. |
VWRosterQuery |
VWRoster.startQuery(java.lang.String indexName,
java.lang.Object[] minValues,
java.lang.Object[] maxValues,
int queryFlags,
java.lang.String filter,
java.lang.Object[] substitutionVars)
Deprecated. Replaced by createQuery |
VWQueueQuery |
VWQueue.startQuery(java.lang.String indexName,
java.lang.Object[] minValues,
java.lang.Object[] maxValues,
int queryFlags,
java.lang.String filter,
java.lang.Object[] substitutionVars)
Deprecated. Replaced by createQuery .
Note: Differences between the use of createQuery() and the deprecated startQuery() method include the following:
Use the following to limit your search:
For this method to successfully return a VWQueueQuery object, a queue item must match all fetch criteria specified by the input parameters. |
VWLogQuery |
VWLog.startQuery(java.lang.String indexName,
java.lang.Object[] minValues,
java.lang.Object[] maxValues,
int queryFlags,
java.lang.String filter,
java.lang.Object[] substitutionVars)
Fetches log items based on conditions specified in the parameters. |
static int |
VWXMLSchemaSubType.stringToType(java.lang.String schemaSubType)
Returns a schema sub type for an ascii string representing the schema sub type. |
static java.lang.Object |
VWFieldType.stringToValue(java.lang.String theString,
int theType,
boolean isArray)
Returns an object or an array of objects of the specified type, as denoted by an input String. |
void |
VWWorkObject.terminate()
Deprecated. Replaced by VWWorkObject.doTerminate() |
void |
VWInstructionElement.terminate()
Deprecated. Replaced by VWInstructionElement.doTerminate() |
static VWException[] |
VWInstructionElement.terminateMany(VWInstructionElement[] elements)
Deprecated. Replaced by VWInstructionElement.doTerminateMany(VWInstructionElement[]) |
static VWException[] |
VWWorkObject.terminateMany(VWWorkObject[] elements)
Deprecated. Replaced by VWWorkObject.doTerminateMany( VWWorkObject[]) |
void |
VWXMLData.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWXMLData object to the buffer specified by the input parameter. |
void |
VWWorkflowRuntimeId.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWWorkflowDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWWorkBasketFilterDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWWorkBasketDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWWorkBasketColumnDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWWFEInstruction.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWWebServiceParameterDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWUserInfo.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWTextAnnotationDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this instance to the buffer specified by the theBuffer parameter. |
void |
VWSystemConfiguration.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWSystemAdministration.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWStepProcessorInfoDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWStepProcessorInfo.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWStepPaletteDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML String that represents this VWStepPaletteDefinition object to the buffer specified by the input parameter. |
void |
VWStepElement.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWStepDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWSimpleInstruction.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWSchema.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWRuleSetDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWRouteDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWRosterElement.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWRosterDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWRollbackInstruction.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWRoleDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWReplyInstruction.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWReceiveInstruction.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWQueueElement.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWQueueDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWPartnerLinkDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWParticipant.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWParameterDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWParameter.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWOperationDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWMilestoneElement.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWMilestoneDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
abstract void |
VWMapNode.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWMapDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWLogElement.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWLogDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWInvokeInstruction.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the StringBuffer specified. |
abstract void |
VWInstructionDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWIndexDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWFieldDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWFaultDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWExposedFieldDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWEventDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWDataField.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWCompoundStepDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWAttributeInfo.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWAttachment.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWAssociationDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
VWApplicationSpaceDefinition.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
IVWtoXML.toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing the object to the buffer specified. |
void |
VWWorkflowCollectionDefinition.toXPDL(java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWWorkflowDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWWFEInstruction.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWWebServiceParameterDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWTextAnnotationDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL String that represents this instance to the buffer specified by the theBuffer parameter. |
void |
VWStepDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWRouteDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWReplyInstruction.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWReceiveInstruction.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWPartnerLinkDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWParameterDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWMilestoneDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string that represents this instance to the buffer specified. |
abstract void |
VWMapNode.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string that represents this instance to the buffer specified. |
void |
VWMapDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWInvokeInstruction.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the StringBuffer specified. |
void |
VWFieldDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWEventDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWCompoundStepDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
VWAssociationDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string that represents this instance to the buffer specified. |
void |
VWFaultDefinition.toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer,
boolean isCatchAll,
VWCompoundStepDefinition myCompoundStep)
Appends an XPDL string representing this instance to the buffer specified. |
VWTransferResult |
VWSession.transfer(VWWorkflowDefinition theWorkflow,
java.lang.String theWFDocKey,
boolean theLinked,
boolean theMakeNewWorkSpace)
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. |
VWTransferResult |
VWSession.transferWFCollection(VWWorkflowCollectionDefinition theWorkflowColl,
java.lang.String theWFDocKey,
boolean theLinked,
boolean theMakeNewWorkSpace)
Transfers a workflow definition collection object, saving it on the Process Engine.The work class names saved on the Process Engine will be the name that is returned by the VWWorkflowDefinition.getName() method for each individual
workflow definition in the workflow collection parameter. |
void |
VWWorkObject.unlock(boolean save,
boolean dispatch)
Deprecated. Replaced by VWWorkObject.doSave(boolean) |
void |
VWInstructionElement.unlock(boolean save,
boolean dispatch)
Deprecated. Replaced by VWInstructionElement.doUnlockMany(VWInstructionElement[], boolean, boolean) |
static VWException[] |
VWInstructionElement.unlockMany(VWInstructionElement[] invs,
boolean save,
boolean dispatch)
Deprecated. Replaced by VWInstructionElement.doUnlockMany(VWInstructionElement[], boolean, boolean) |
static VWException[] |
VWWorkObject.unlockMany(VWWorkObject[] workObjects,
boolean save,
boolean dispatch)
Deprecated. Replaced by VWWorkObject.doUnlockMany(VWWorkObject[], boolean, boolean) |
void |
VWSession.updateAPIUserCache()
Refreshes the internal cache of user names, which is populated by calls from convertIdtoUserName(), convertUserNametoId() and getUserNames(), for performance. |
void |
VWSystemConfiguration.updateApplicationSpaceDefinition(VWApplicationSpaceDefinition theApplicationSpaceDef)
Updates an application space definition. |
void |
VWSystemConfiguration.updateLogDefinition(VWLogDefinition theLogDefinition)
Updates a log definition. |
void |
VWSystemConfiguration.updateQueueDefinition(VWQueueDefinition theQueueDefinition)
Updates a queue definition. |
void |
VWApplicationSpaceDefinition.updateRoleDefinition(VWRoleDefinition theRoleDefinition)
Updates a role definition. |
void |
VWSystemConfiguration.updateRosterDefinition(VWRosterDefinition theRosterDefinition)
Updates a roster definition. |
void |
VWTextAnnotationDefinition.validate(java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector. |
void |
VWRouteDefinition.validate(java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWParameterDefinition.validate(java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWWebServiceParameterDefinition.validate(java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWAssociationDefinition.validate(java.util.Vector EDefVector,
VWMapDefinition map,
int id)
Validates this instance, appending any validation errors found to the specified Vector object. |
VWValidationError[] |
VWWorkflowDefinition.validate(VWSession theSession,
boolean fixupSteps)
Validates this instance. |
java.util.HashMap |
VWWorkflowCollectionDefinition.validate(VWSession theSession,
boolean fixupSteps)
Validates this instance. |
void |
VWStepDefinition.validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWSchema.validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWRuleSetDefinition.validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWPartnerLinkDefinition.validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWMilestoneDefinition.validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
abstract void |
VWMapNode.validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWFieldDefinition.validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWCompoundStepDefinition.validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWWFEInstruction.validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWSimpleInstruction.validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWRollbackInstruction.validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWReplyInstruction.validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWReceiveInstruction.validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWInvokeInstruction.validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
abstract void |
VWInstructionDefinition.validate(VWSession theSession,
java.util.Vector EDefHandler,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWFaultDefinition.validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep,
int instId,
int faultId)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWEventDefinition.validate(VWSession theSession,
VWWorkflowDefinition theWorkflow,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep,
int instId,
int eventId)
Validates this instance, appending any validation errors found to the specified Vector object. |
void |
VWWorkflowDefinition.write(java.io.OutputStream theStream)
Writes this instance to an output stream. |
void |
VWWorkflowCollectionDefinition.write(java.io.OutputStream theStream)
Writes this instance to a specified output stream. |
void |
VWStepPaletteDefinition.write(java.io.OutputStream theStream)
Writes this VWStepPaletteDefinition object to an output stream. |
void |
VWWorkflowDefinition.writeToFile(java.lang.String theFileName)
Writes this instance to a file. |
void |
VWWorkflowCollectionDefinition.writeToFile(java.lang.String theFileName)
Writes this instance to a specified file. |
void |
VWStepPaletteDefinition.writeToFile(java.lang.String theFileName)
Writes this VWStepPaletteDefinition object to a file. |
Constructors in filenet.vw.api that throw VWException | |
---|---|
VWAttachment(java.lang.String theValue)
Creates a VWAttachment object and sets the initial value. |
|
VWAttributeInfo()
Constructor for creating a VWAttributeInfo Object. |
|
VWSession(java.lang.String url)
Creates a new session in an environment where the Java™ Authentication and Authorization Service (JAAS) context is already established. |
|
VWSession(java.lang.String user,
java.lang.String password,
java.lang.String connectionPointName)
Establishes a new session based on a specified connection point. |
|
VWSession(java.lang.String domain,
java.lang.String user,
java.lang.String password,
java.lang.String connectionPointName)
Establishes a session for a specified domain and connection point. |
|
VWStepPaletteDefinition()
Public constructor for the VWStepPaletteDefinition class. |
|
VWStepProcessorInfoDefinition(int theId,
int theProcessorType,
java.lang.String theName,
int theAppType,
java.util.Hashtable theLocations,
int theWidth,
int theHeight,
java.lang.String theApp)
Creates a VWStepProcessorInfoDefinition object using input arguments, including a hashtable of the locations associated with this step processor, for each web application. |
|
VWStepProcessorInfoDefinition(int theId,
int theProcessorType,
java.lang.String theName,
int theAppType,
java.lang.String theLocation,
int theWidth,
int theHeight,
java.lang.String theApp)
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. |
|
VWStepProcessorInfoDefinition(VWStepProcessorInfo stepProcessorInfo)
Creates a VWStepProcessorInfoDefinition object using the specified step processor info object. |
|
VWWorkflowDefinition()
Creates a VWWorkflowDefinition instance. |
|
VWXMLData(java.lang.String theNewXML,
java.lang.String theNewSchemaName,
java.lang.String theNewElementName)
Public constructor. |
|
Process API | ||||||||
PREV NEXT | FRAMES NO FRAMES |