Process API

Deprecated API


Contents
Deprecated Classes
filenet.vw.api.VWInstructionElement
          Replaced by VWStepElement 
 

Deprecated Fields
filenet.vw.api.VWActionType.ACTION_TYPE_TERMINATE
          Value of 17. Ends processing of a workflow branch, other work objects in a workflow (e.g. if splits have occurred), will continue processing. 
filenet.vw.api.VWFieldType.FIELD_TYPEDEF_TIME32
          for creation. Users are encouraged to use FIELD_TYPEDEF_TIME64 for creation of exposed fields. 
filenet.vw.api.VWOperationType.OP_TYPE_TERMINATE
          - use OP_TYPE_TERMINATE_BRANCH instead, to match the new terminology on the server, terminate was renamed "terminate branch" to distinguish it from the new "terminate process" operation. The value is 17 for both "terminate branch" and "terminate", but "terminate branch" is the preferred name. 
filenet.vw.api.VWSession.PRODUCT_BPS
          Replaced by use of VWSession.setDefaultWebApplication(int) 
filenet.vw.api.VWSession.PRODUCT_CUSTOM
          Replaced by use of VWSession.setDefaultWebApplication(int) 
filenet.vw.api.VWSession.PRODUCT_OPEN_CLIENT
          Replaced by use of VWSession.setDefaultWebApplication(int) 
filenet.vw.api.VWSession.PRODUCT_PW
          Replaced by use of VWSession.setDefaultWebApplication(int) 
filenet.vw.api.VWRoster.QUERY_GET_SYSTEM_FIELDS
          Not replaced. This is the default. 
filenet.vw.api.VWQueue.QUERY_GET_SYSTEM_FIELDS
          Not replaced. This is the default. 
filenet.vw.api.VWRoster.QUERY_GET_TRANSLATED_SYSTEM_FIELDS
          Not replaced. This is the default. 
filenet.vw.api.VWQueue.QUERY_GET_TRANSLATED_SYSTEM_FIELDS
          Not replaced. This is the default. 
 

Deprecated Methods
filenet.vw.api.VWWorkflowDefinition.createFieldUsingObject(String, Object)
          Replaced by VWWorkflowDefinition.createFieldUsingString(String, String, int, boolean) 
filenet.vw.api.VWCompoundStepDefinition.createTerminateInstruction()
          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. 
filenet.vw.api.VWSystemAdministration.createUserInfo()
          VWUserInfo records are created on the server in P8PE4.0 
filenet.vw.api.VWWorkflowDefinition.deleteMap(int)
          Replaced by VWWorkflowDefinition.deleteMap(String) 
filenet.vw.api.VWWorkflowDefinition.deleteRuleSet(VWRuleSetDefinition)
          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()). 
filenet.vw.api.VWStepPaletteDefinition.deleteStep(String)
          Replaced by VWStepPaletteDefinition.deleteStep(int) 
filenet.vw.api.VWSession.fetchAttachmentIsReferencedBy(VWAttachment)
          Replaced by createAttachmentTrackingQuery 
filenet.vw.api.VWSession.fetchAttachmentIsReferencedBy(VWAttachment, int)
          Replaced by VWSession.createAttachmentTrackingQuery(VWAttachment) 
filenet.vw.api.VWQueue.fetchIndexFields()
          Replaced by fetchQueueDefinition Fetches the user-defined index names for a specified queue. 
filenet.vw.api.VWQueue.fetchIndexKeyFields(String)
          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. 
filenet.vw.api.VWWorkObject.fetchInstructionElement(boolean, boolean)
          Use fetchStepElement instead. Fetches the instruction element information associated with this work object. 
filenet.vw.api.VWRosterElement.fetchInstructionElement(boolean, boolean)
          Replaced by fetchStepElement 
filenet.vw.api.VWQueueElement.fetchInstructionElement(boolean, boolean)
          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. 
filenet.vw.api.VWQueueQuery.fetchInstructionElements(int)
          Replaced by VWQueueQuery.next() 
filenet.vw.api.VWQueueQuery.fetchQueueElements(int)
          Replaced by VWQueueQuery.next() 
filenet.vw.api.VWQueue.fetchQueueFields()
          Replaced by fetchQueueDefinition Fetches the user-defined search fields for a specified queue. 
filenet.vw.api.VWRosterQuery.fetchRosterElements(int)
          Replaced by VWRosterQuery.next() 
filenet.vw.api.VWSession.fetchUserGroups(int)
          Replaced by VWSession.findGroups(String searchPattern, int searchType, int sortType, int maxBufferSize) 
filenet.vw.api.VWSession.fetchUserGroupsPx(int)
          Replaced by VWSession.findGroupsByDomain(String secDomainName, String searchPattern, int searchType, int sortType, int maxBufferSize) 
filenet.vw.api.VWSession.fetchUsers(int, boolean)
          Replaced by VWSession.findUsers(String searchPattern, int searchType, int sortType, int maxBufferSize) VWSession.findGroups(String searchPattern, int searchType, int sortType, int maxBufferSize) 
filenet.vw.api.VWSession.fetchUsersPx(int, boolean)
          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) 
filenet.vw.api.VWProcess.fetchWorkflowDefinition()
          Replaced by fetchWorkflowDefinition Fetches the workflow definition for this workflow process. 
filenet.vw.api.VWSession.fetchWorkflowDefinition(int, String)
          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. 
filenet.vw.api.VWRosterQuery.fetchWorkObjects(int)
          Replaced by VWRosterQuery.next() 
filenet.vw.api.VWQueueQuery.fetchWorkObjects(int)
          Replaced by VWQueueQuery.next() 
filenet.vw.api.VWRoster.getCount()
          Replaced by VWRoster.fetchCount() 
filenet.vw.api.VWQueue.getCount()
          Replaced by VWQueue.fetchCount() 
filenet.vw.api.VWSession.getDefaultSecurityDomain()
          P8 PE BPM 4.0 does not support the concept of "default security domain." 
filenet.vw.api.VWWorkObject.getExceptionInstructionSheet()
          Replaced by getExceptionMap 
filenet.vw.api.VWValidationError.getId()
          Replaced by VWValidationError.getStepId(), VWMapDefinition.getMapId(), and VWValidationError.getSubStepId() in combination. Gets the value in the ID property of this validation error. 
filenet.vw.api.VWStepProcessorInfoDefinition.getLocation()
          Replaced by VWStepProcessorInfoDefinition.getLocation(int). 
filenet.vw.api.VWStepProcessorInfo.getLocation()
          Replaced by VWStepProcessorInfo.getLocation(int). 
filenet.vw.api.VWWorkflowDefinition.getMap(int)
          Replaced by VWWorkflowDefinition.getMap(String). Note: getMap(String) takes a map name as a parameter, rather than a map ID. 
filenet.vw.api.VWWorkObject.getProcess()
          Replaced by fetchProcess 
filenet.vw.api.VWRosterElement.getProcess()
          Replaced by VWStepElement.fetchProcess() or VWWorkObject.fetchProcess(), depending on the type of process. 
filenet.vw.api.VWSession.getQueueNames(boolean)
          Replaced by fetchQueueNames. 
filenet.vw.api.VWApplicationSpaceDefinition.getReadSecurity()
            
filenet.vw.api.VWApplicationSpaceDefinition.getReadSecurityPx()
            
filenet.vw.api.VWSession.getRosterNames()
          Replaced by VWSession.fetchQueueNames(int) or VWSession.fetchRosterNames(boolean). 
filenet.vw.api.VWMapNode.getRuleSets(int)
          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. 
filenet.vw.api.VWUserInfo.getServerAssignment()
          BPM 4.0 release farming does not support multiple servers 
filenet.vw.api.VWSystemAdministration.getStatisticsSnapshotInterval()
          Not replaced 
filenet.vw.api.VWStepPaletteDefinition.getStep(String)
          Replaced by VWStepPaletteDefinition.getStep(int) 
filenet.vw.api.VWWorkObject.getTrackers()
          Replaced by VWWorkObject.getTrackersPx(), which returns an array of VWParticipant objects for the tracker participants associated with this work object. 
filenet.vw.api.VWRuleSetDefinition.getValue()
          Use #getName() instead. This method calls getName() 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. 
filenet.vw.api.VWWorkObject.getWorkFlowNumber()
          Replaced by VWWorkObject.getWorkflowNumber() 
filenet.vw.api.VWStepElement.getWorkFlowNumber()
          Replaced by VWStepElement.getWorkflowNumber() Gets the string version of the workflow number. Use the returned F_WorkFlowNumber as an index key component. 
filenet.vw.api.VWRosterElement.getWorkFlowNumber()
          Replaced by VWRosterElement.getWorkflowNumber() 
filenet.vw.api.VWQueueElement.getWorkPerformerClassName()
          Replaced by VWQueueElement.getQueueName() Gets the name of the Work Performer Class associated with the queue on which the workflow object currently resides. 
filenet.vw.api.VWRosterQuery.isDone()
          Replaced by VWRosterQuery.next(). 
filenet.vw.api.VWQueueQuery.isDone()
          Replaced by VWQueueQuery.next() 
filenet.vw.api.VWWorkObject.lock(boolean)
          Replaced by VWWorkObject.doLock( boolean) 
filenet.vw.api.VWInstructionElement.lock(boolean)
          Replaced by VWInstructionElement.doLock(boolean) 
filenet.vw.api.VWInstructionElement.lockMany(VWInstructionElement[], boolean)
          Replaced by VWInstructionElement.doLockMany(VWInstructionElement[], boolean) 
filenet.vw.api.VWWorkObject.lockMany(VWWorkObject[], boolean)
          Replaced by VWWorkObject.doLockMany(VWWorkObject[], boolean) 
filenet.vw.api.VWMapDefinition.pasteSteps(String)
          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. 
filenet.vw.api.VWWorkObject.refresh(boolean, boolean)
          Replaced by VWWorkObject.doRefresh(boolean, boolean) 
filenet.vw.api.VWInstructionElement.refresh(boolean, boolean)
          Replaced by VWInstructionElement.doRefresh(boolean, boolean) 
filenet.vw.api.VWWorkObject.save()
          Replaced by VWWorkObject.doSave(boolean) 
filenet.vw.api.VWInstructionElement.save()
          Replaced by VWInstructionElement.doSave(boolean) 
filenet.vw.api.VWInstructionElement.saveMany(VWInstructionElement[])
          Replaced by VWInstructionElement.doSaveMany(VWInstructionElement[]) 
filenet.vw.api.VWWorkObject.saveMany(VWWorkObject[])
          Replaced by VWWorkObject.doSaveMany(VWWorkObject[]) 
filenet.vw.api.VWSession.setAuditState(String, Integer[])
          Replaced by inserting a copy of the fnlog4j.properties file in the fnsw\java\jre\lib directory. Edit this file to view or change logging properties.

For detail information on the components of the fnlog4j.properties file, see the documentation on the members of the java.util.logging class.

 
filenet.vw.api.VWWorkObject.setFieldValue(String, Object)
          Replaced by VWWorkObject.setFieldValue(String, Object, boolean) 
filenet.vw.api.VWStepProcessorInfoDefinition.setLocation(String)
          Replaced by VWStepProcessorInfoDefinition.setLocations(Hashtable). 
filenet.vw.api.VWUserInfo.setName(String)
          VWUserInfo records are created on the server, the name cannot be changed 
filenet.vw.api.VWSession.setProductId(int)
          Replaced by VWSession.setDefaultWebApplication(int) 
filenet.vw.api.VWApplicationSpaceDefinition.setReadSecurityPx(VWParticipant[])
            
filenet.vw.api.VWMapNode.setRuleSets(int, VWRuleSetDefinition[])
          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. 
filenet.vw.api.VWUserInfo.setServerAssignment(int)
          BPM 4.0 release farming does not support multiple servers 
filenet.vw.api.VWSystemAdministration.setStatisticsSnapshotInterval(int)
          Not replaced 
filenet.vw.api.VWSystemAdministration.setSystemWideFlags(int)
          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. 
filenet.vw.api.VWRuleSetDefinition.setValue(String)
          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. 
filenet.vw.api.VWRoster.startQuery(String, Object[], Object[], int, String, Object[])
          Replaced by createQuery 
filenet.vw.api.VWQueue.startQuery(String, Object[], Object[], int, String, Object[])
          Replaced by createQuery.

Note: Differences between the use of createQuery() and the deprecated startQuery() method include the following:

  • createQuery() uses a fetchType input parameter.
  • createQuery()'s resultant query object uses iterator methods VWQueueQuery.next() and VWQueueQuery.hasNext(), emulating the Collection Model in Java 2.
  • Warning You cannot use iterator methods next() or hasNext() on a VWQueueQuery object instantiated by the deprecated startQuery() method--the iterator methods throw an exception if you do.
The search conditions you specify in the parameters of this method cause the retrieval of queue items based on a filter condition and a range in a search index.

Use the following to limit your search:

  • Logical AND for the minimum and maximum search index values (minValue and maxValue).
  • Search options (queryFlags).
  • Filters with substitution variables (substitutionVars).

For this method to successfully return a VWQueueQuery object, a queue item must match all fetch criteria specified by the input parameters. 

filenet.vw.api.VWWorkObject.terminate()
          Replaced by VWWorkObject.doTerminate() 
filenet.vw.api.VWInstructionElement.terminate()
          Replaced by VWInstructionElement.doTerminate() 
filenet.vw.api.VWInstructionElement.terminateMany(VWInstructionElement[])
          Replaced by VWInstructionElement.doTerminateMany(VWInstructionElement[]) 
filenet.vw.api.VWWorkObject.terminateMany(VWWorkObject[])
          Replaced by VWWorkObject.doTerminateMany( VWWorkObject[]) 
filenet.vw.api.VWWorkObject.unlock(boolean, boolean)
          Replaced by VWWorkObject.doSave(boolean) 
filenet.vw.api.VWInstructionElement.unlock(boolean, boolean)
          Replaced by VWInstructionElement.doUnlockMany(VWInstructionElement[], boolean, boolean) 
filenet.vw.api.VWInstructionElement.unlockMany(VWInstructionElement[], boolean, boolean)
          Replaced by VWInstructionElement.doUnlockMany(VWInstructionElement[], boolean, boolean) 
filenet.vw.api.VWWorkObject.unlockMany(VWWorkObject[], boolean, boolean)
          Replaced by VWWorkObject.doUnlockMany(VWWorkObject[], boolean, boolean) 
 

Deprecated Constructors
filenet.vw.api.VWStepProcessorInfoDefinition(int, int, String, int, String, int, int, String)
          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.  
 


Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.