filenet.vw.api

Class VWInstructionElement

  • java.lang.Object
    • filenet.vw.api.VWInstructionElement

    • Method Detail

      • fetchWorkObject

        public VWWorkObject fetchWorkObject(boolean lock,
                                    boolean overrideLock)
                             throws VWException
        Deprecated. 
        Fetches a workflow object specified in the Instruction Element.
        Parameters:
        lock - A Boolean value. Specify true to lock the workflow object; false otherwise. See also next parameter, below.
        overrideLock - A Boolean value. Specify true to override an existing lock on the workflow object, except for a system lock.
        Returns:
        An instance of the Workflow object that was specified in the Instruction Element.
        Throws:
        VWException - Thrown if this method cannot fetch a workflow object specified in the Instruction Element.

      • refresh

        public void refresh(boolean lock,
                    boolean overrideLock)
             throws VWException
        Deprecated. Replaced by VWInstructionElement.doRefresh(boolean, boolean)
        Fetches the specified Instruction Element to update workflow information.
        Parameters:
        lock - A Boolean value. Specify true to lock the workflow object.
        overrideLock - A Boolean value. Specify true to override an existing lock on the workflow object, except for a system lock.
        Throws:
        VWException - Thrown if this method cannot fetch the specified Instruction Element to update workflow information.

      • doRefresh

        public void doRefresh(boolean lock,
                      boolean overrideLock)
               throws VWException
        Deprecated. 
        Fetches the specified Instruction Element to get the most current information.
        Parameters:
        lock - A Boolean value. Specify true to lock the workflow object.
        overrideLock - A Boolean value. Specify true to override an existing lock on the workflow object, except for a system lock object.
        Throws:
        VWException - The fetch did not succeed.

      • unlockMany

        public static VWException[] unlockMany(VWInstructionElement[] invs,
                                       boolean save,
                                       boolean dispatch)
                                throws VWException
        Deprecated. Replaced by VWInstructionElement.doUnlockMany(VWInstructionElement[], boolean, boolean)
        Unlocks the array of workflow objects specified by the passed Instruction Elements.

        The workflow objects must be from the same queue or roster. Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.

        Parameters:
        invs - An array of Instruction Elements to be processed.
        save - A Boolean value. Specify true to save workflow object data field values.
        dispatch - A Boolean value. Specify true to dispatch the workflow objects. You must save a workflow object before dispatching it.
        Returns:
        An array of null values or a VWException corresponding to the input elements.
        Throws:
        VWException - The method throws an exception if a general system or database error occurs.

      • doUnlockMany

        public static VWException[] doUnlockMany(VWInstructionElement[] invs,
                                         boolean save,
                                         boolean dispatch)
                                  throws VWException
        Deprecated. 
        Unlocks the array of workflow objects specified by the passed Instruction Elements.

        Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.

        Parameters:
        invs - An array of Instruction Elements to be processed.
        save - A Boolean value. Specify true to save workflow object data field values.
        dispatch - A Boolean value. Specify true to dispatch the workflow objects. You must save a workflow object before dispatching it.
        Returns:
        An array of values, either null or VWException, that corresponds to the input elements.
        Throws:
        VWException - The method throws an exception if a general system or database error occurs.

      • saveMany

        public static VWException[] saveMany(VWInstructionElement[] invs)
                              throws VWException
        Deprecated. Replaced by VWInstructionElement.doSaveMany(VWInstructionElement[])
        Saves and updates information for each workflow object specified by the passed array of Instruction Elements.

        The Instruction Elements must be from from the same queue or roster. Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.

        Parameters:
        invs - An array of Instruction Elements to be processed.
        Returns:
        An array of values, either null or VWException, that corresponds to the input elements.
        Throws:
        VWException - The method throws an exception if a general system or database error occurs.

      • doSaveMany

        public static VWException[] doSaveMany(VWInstructionElement[] invs)
                                throws VWException
        Deprecated. 
        Saves and updates information for each workflow object specified by the passed array of Instruction Elements.

        The Instruction Elements must be from from the same queue or roster. Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.

        Parameters:
        invs - An array of Instruction Elements to be processed.
        Returns:
        An array of values, either null or VWException, that corresponds to the input elements.
        Throws:
        VWException - The method throws an exception if a general system or database error occurs.

      • unlock

        public void unlock(boolean save,
                   boolean dispatch)
            throws VWException
        Deprecated. Replaced by VWInstructionElement.doUnlockMany(VWInstructionElement[], boolean, boolean)
        Unlocks the workflow object specified by the Instruction Element.
        Parameters:
        save - A Boolean value. Specify true to save the workflow object data field values.
        dispatch - A Boolean value. Specify true to dispatch the workflow object. You must save a workflow object before dispatching it.
        Throws:
        VWException - The method throws an exception if the workflow object could not be unlocked. An example would be if it had not been locked by the current user.

      • setException

        public void setException(java.lang.String anInstructionSheetName,
                         java.lang.String aDescription)
                  throws VWException
        Deprecated. 
        Sets a exception condition for the workflow object specified by the Instruction Element. If the parameters for this method are set, a VWException occurs when the workflow object is saved or dispatched. The object dispatches to the named instruction sheet.

        If a user sets the dispatch flag to 'true', the system catches an error in a parameter value only after the application saves the Instruction Element or unlocks the workflow object associated with the Instruction Element.

        Parameters:
        anInstructionSheetName - The name of the instruction sheet* Process Engine executes when an exception occurs. A null entry, which is the default, indicates that no exception occurs. Any other entry means an exception occurs when the system unlocks and dispatches a workflow object.
        aDescription - -- The description of a VWException, which is not a Java exception.
        Throws:
        VWException - An exception is thrown if the exception strings could not be set.

      • getExceptionInstructionSheet

        public java.lang.String getExceptionInstructionSheet()
        Deprecated. 
        Returns the string value the user set as the name of the exception instruction sheet.
        Returns:
        The method returns null if no exception is to be raised on the dispatch or save; otherwise, the method returns a string containing the name of the instruction sheet to return to if the Java application raises a VWException. This is not a Java exception.
        See Also:
        VWInstructionElement.setException(java.lang.String, java.lang.String)

      • save

        public void save()
          throws VWException
        Deprecated. Replaced by VWInstructionElement.doSave(boolean)
        Saves the workflow object.
        Throws:
        VWException - The method throws an exception if the method could not save the workflow object. This would be the case, for example, if a user other than the current user locked the workflow object.

      • doLockMany

        public static VWException[] doLockMany(VWInstructionElement[] intrs,
                                       boolean overrideLock)
                                throws VWException
        Deprecated. 
        Locks Instruction Elements associated with workflow objects in a single call. This method is typically used in conjunction with VWInstructionElement.doSaveMany(filenet.vw.api.VWInstructionElement[]), to update groups of Instruction Elements.

        The array of workflow objects come from one of the following sources:

        • Query on the same roster or queue
        • Fetch results from the same roster or queue
        • VWRosterElement class
        • VWQueueElement class
        Parameters:
        intrs - An array of Instruction Elements to be processed.
        overrideLock - A Boolean value. Specify true to override locks that are not system locks.
        Returns:
        If the operation succeeds, the method returns null. If the operation fails, the method returns a VWException, which indicates a problem with the specified input element.
        Throws:
        VWException - The method throws an exception if a general system or database error occurs.
        See Also:
        VWInstructionElement.doSaveMany(VWInstructionElement[])

      • lock

        public void lock(boolean overrideLock)
          throws VWException
        Deprecated. Replaced by VWInstructionElement.doLock(boolean)
        Locks a workflow object.
        Parameters:
        overrideLock - A Boolean value. Specify true to override locks that are not system locks.
        Throws:
        VWException - Thrown if the workflow object could not be locked.

      • doLock

        public void doLock(boolean overrideLock)
            throws VWException
        Deprecated. 
        Locks a workflow object.
        Parameters:
        overrideLock - A Boolean value. Specify true to override locks that are not system locks.
        Throws:
        VWException - Thrown if the workflow object could not be locked.

      • terminateMany

        public static VWException[] terminateMany(VWInstructionElement[] elements)
                                   throws VWException
        Deprecated. Replaced by VWInstructionElement.doTerminateMany(VWInstructionElement[])
        Terminates workflow objects associated with the passed Instruction Elements. Terminating a workflow object dispatches the object to the terminate instruction sheet. The array of workflow objects must come from a query on the same roster or queue.
        Parameters:
        elements - An array of workflow objects to be processed.
        Returns:
        If the operation succeeds, the method returns null. If the operation fails, the method returns a VWException which corresponds with the input elements.
        Throws:
        VWException - This method throws an error if a general system or database error occurs.

      • doTerminateMany

        public static VWException[] doTerminateMany(VWInstructionElement[] elements)
                                     throws VWException
        Deprecated. 
        Terminates workflow objects associated with the passed Instruction Elements. Terminating a workflow object dispatches the object to the terminate instruction sheet. The array of workflow objects must come from a query on the same roster or queue.
        Parameters:
        elements - An array of workflow objects to be processed.
        Returns:
        If the operation succeeds, the method returns null. If the operation fails, the method returns a VWException which corresponds with the input elements.
        Throws:
        VWException - This method throws an error if a general system or database error occurs.

      • terminate

        public void terminate()
               throws VWException
        Deprecated. Replaced by VWInstructionElement.doTerminate()
        Terminates the workflow object associated with the Instruction Element. Terminating a workflow object dispatches the object to the terminate instruction sheet.
        Throws:
        VWException - This method throws an error if the workflow object could not be terminated. An example of this would be if a user other than the current user locks the workflow object.

      • doTerminate

        public void doTerminate()
                 throws VWException
        Deprecated. 
        Terminates the workflow object associated with the Instruction Element. Terminating a workflow object dispatches the object to the terminate instruction sheet.
        Throws:
        VWException - This method throws an error if the workflow object could not be terminated. An example of this would be if a user other than the current user locks the workflow object.

      • fetchLockedStatus

        public int fetchLockedStatus()
                      throws VWException
        Deprecated. 
        Checks the status of the workflow object. This method requires network transfer to get the status information.
        Returns:
        An integer value indicating the lock status of the workflow object. 0(zero) indicates that the object is not locked(LOCKED_BY_NONE, 1(one) indicates that the object is locked by a user(LOCKED_BY_USER), and 2(two) indicates the object is locked by the system (LOCKED_BY_SYSTEM). See VWQueueElement for status definitions.
        Throws:
        VWException - This method throws an error if the workflow object lock status could not be determined.
        See Also:
        VWQueueElement

      • getFieldNames

        public java.lang.String[] getFieldNames()
        Deprecated. 
        Lists the field names for the Instruction Element parameters. This method retrieves only user-defined fields for Instruction Elements.
        Returns:
        An array of the user-defined field names.

      • getFieldValue

        public java.lang.Object getFieldValue(java.lang.String fieldName)
                               throws VWException
        Deprecated. 
        Gets the value of the specified field.
        Parameters:
        fieldName - The name of the specified field.
        Returns:
        A object containing the value of the specified field; a field that has an OUT mode parameter returns a null value. An object and an array of objects must be of one of the following types: Integer, String, Double, or Boolean. A field can have a null value.
        Throws:
        VWException - The method throws an exception if the field specified in the fieldName parameter string does not exist.

      • setFieldValue

        public void setFieldValue(java.lang.String fieldName,
                          java.lang.Object fieldValue)
                   throws VWException
        Deprecated. 
        Sets a value for the specified field.

        Note: Only fields with OUT and INOUT parameter modes are editable.

        Parameters:
        fieldName - The name of the required field.
        fieldValue - An object containing the value of the named field. An object and an array of objects must be of one of the following types: Integer, String, Double, or Boolean. A field can have a null value.
        Throws:
        VWException - The method throws an exception if the field specified in the fieldName parameter string does not exist.
        See Also:
        VWInstructionElement.hasFieldName( String )

      • hasFieldName

        public boolean hasFieldName(java.lang.String fieldName)
                     throws VWException
        Deprecated. 
        Determines whether or not the specified field exists.
        Parameters:
        fieldName - The name of the specified field.
        Returns:
        A Boolean value. The method returns true if the field specified in the fieldName parameter exists; the method returns false if the system cannot find the field, for any reason.
        Throws:
        VWException - The method throws an exception if the field name parameter is null.

      • getIsAltered

        public boolean getIsAltered()
        Deprecated. 
        Determines whether or not the fields have been modified.
        Returns:
        A Boolean value. The method returns true if a field has been altered; otherwise, the method returns false.

      • hasBeenAltered

        public boolean hasBeenAltered(java.lang.String fieldName)
                       throws VWException
        Deprecated. 
        Determines whether or not the field has been modified.
        Parameters:
        fieldName - The name of the specified field.
        Returns:
        A Boolean value. The method returns true if the field has been modified; otherwise, the method returns false.
        Throws:
        VWException - The method throws an exception if the field name parameter is null.

      • getFieldMode

        public int getFieldMode(java.lang.String fieldName)
                 throws VWException
        Deprecated. 
        Specifies the parameter mode for the specified field as IN, OUT, or INOUT. Only OUT and INOUT parameter modes are editable. The Operation parameter mode determines the direction which data flows between the parameter and the workflow object. The mode controls the flow in the following manner:

        • IN - data flows from the parameter to the workflow object data field.
        • OUT - data flows from the workflow object data field to the parameter.
        • INOUT - data flows from the parameter to the workflow object data field, then from the workflow object data field to the parameter.
        Parameters:
        fieldName - The name of the required field.
        Returns:
        An integer value indicating the mode of the specified field: 1(one) indicates IN mode, 2(two) indicates OUT mode, and 3(three) indicates INOUT mode.
        Throws:
        VWException - The method throws an exception if the field specified in the fieldName parameter does not exist.

      • getWorkObjectName

        public java.lang.String getWorkObjectName()
                                   throws VWException
        Deprecated. 
        Gets the workflow object name. The name is the workflow object ID field, set on the work class properties page in the Composer interface.
        Returns:
        A string value containing the name of the workflow object.
        Throws:
        VWException - The method throws an exception if the field specified in the fieldName parameter does not exist.

      • getWorkObjectNumber

        public java.lang.String getWorkObjectNumber()
                                     throws VWException
        Deprecated. 
        Gets the string version of the F_WobNum(workflow object number). Use the returned string as an index value.
        Returns:
        The workflow object number, which corresponds to the F_WobNum queue field.
        Throws:
        VWException - The method throws an exception if a general system or database problem occurs.

      • getTag

        public java.lang.String getTag()
                        throws VWException
        Deprecated. 
        Gets the workflow object tag, as the workflow system stores it in the database. The workflow system creates the workflow object tag by normalizing numeric representation in the workflow name. Workflow system normalization formats numbers in a name to be consistently sortable.
        Returns:
        A string representing the Tag.
        Throws:
        VWException - The method throws an exception if a general system or database problem occurs.

      • getWorkClassName

        public java.lang.String getWorkClassName()
                                  throws VWException
        Deprecated. 
        Gets the name of the work class which can be used to instantiate the workflow object.
        Returns:
        A string name of the work class.
        Throws:
        VWException - The method throws an exception if a general system or database problem occurs.

      • getWorkPerformerClassName

        public java.lang.String getWorkPerformerClassName()
                                           throws VWException
        Deprecated. 
        Gets the name of the Work Performer Class associated with the queue on which the workflow object currently resides.
        Returns:
        The name of the current Work Performer Class.
        Throws:
        VWException - The method throws an exception if a general system or database problem occurs.

      • getOperationName

        public java.lang.String getOperationName()
                                  throws VWException
        Deprecated. 
        Gets the name of the current Operation.
        Returns:
        The name of current Operation.
        Throws:
        VWException - The method throws an exception if a general system or database problem occurs.

      • logMessage

        public void logMessage(int loggingOption,
                       java.lang.String message)
                throws VWException
        Deprecated. 
        Logs a message to the default server log. This method is does not operate on rosters, so it should not be used on objects created by the VWRoster.createQuery() or the deprecated method VWRoster.startQuery(). To log user-defined messages, the specified logging option must be currently turned ON(1) in the WorkPerformer's set of logging options and in the configuration logging vector. Each of the specified logging options is for the programmer's use in categorizing logging messages.
        Parameters:
        loggingOption - An integer value that indicates the available Process Engine message category to log. The programmer is responsible for maintaining meaningful message grouping in each category. Available logging categories or "option types" are:

        • 410: LOGGING_OPTION_TYPE_USER1_MESSAGE1
        • 420: LOGGING_OPTION_TYPE_USER1_MESSAGE2
        • 430: LOGGING_OPTION_TYPE_USER1_MESSAGE3
        • 440: LOGGING_OPTION_TYPE_USER1_MESSAGE4
        • 450: LOGGING_OPTION_TYPE_USER2_MESSAGE1
        • 460: LOGGING_OPTION_TYPE_USER2_MESSAGE2
        • 470: LOGGING_OPTION_TYPE_USER2_MESSAGE3
        • 480: LOGGING_OPTION_TYPE_USER3_MESSAGE4
        message - The text message to log.
        Throws:
        VWException - The method throws an exception if the message could not be logged, as when this method is used on a roster. LogMessage is not intended for use with an object created by the createQuery() or startQuery() (deprecated) methods of the VWRoster class.
        Since:
        VWWS3.10

      • toString

        public java.lang.String toString()
        Deprecated. 
        Provides a string version of the workflow object name.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string containing name of the workflow object.

      • doAbort

        public void doAbort()
             throws VWException
        Deprecated. 
        Unlocks the workflow object associated with the Instruction Element, without updating the workflow object fields.
        Throws:
        VWException - The method throws an exception if the unlock operation for the workflow object is unsuccessful.
        Since:
        VWWS3.10

      • doDispatch

        public void doDispatch()
                throws VWException
        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.
        Throws:
        VWException - Thrown if the system encounters an error while attempting to save the current step or move the step to the next workflow step.
        Since:
        VWWS3.10

      • getExceptionMap

        public java.lang.String getExceptionMap()
                                 throws VWException
        Deprecated. 
        Gets the exception workflow map for the workflow object associated with the Instruction Element.
        Returns:
        the exception map name, if set.
        Throws:
        VWException - The method throws an exception if the exception workflow map for the workflow object could not be retrieved. This would often be a general system or database problem.
        Since:
        VWWS3.10

      • doSave

        public void doSave(boolean unlock)
            throws VWException
        Deprecated. 
        Saves the workflow object associated with the Instruction Element.
        Parameters:
        unlock - A Boolean value. Specify true to save and unlock the workflow object, which stops the processing associated with the workflow object. Specify false to save the workflow object, which keeps the object locked and continues processing it.
        Throws:
        VWException - The method throws an exception if the save operation fails or the workflow object was not locked by the current user.
        Since:
        VWWS3.10

      • getParameterDataFields

        public VWParameter[] getParameterDataFields()
                                     throws VWException
        Deprecated. 
        Gets the data fields for the Instruction Element, which excludes participant lists and attachments.
        Returns:
        An array of data fields for the Instruction Element.
        Throws:
        VWException
        Since:
        VWWS3.10

      • getWorkFlowNumber

        public java.lang.String getWorkFlowNumber()
                                   throws VWException
        Deprecated. 
        Gets the workflow number. Use the returned F_WorkFlowNumber value as an index key component.
        Returns:
        The string representing the workflow number.
        Throws:
        VWException - An exception is thrown under the following conditions:
        • There is no workflow number currently assigned. This may be because the object has not yet been dispatched (has not yet become a work object).
        • The workflow number is null.

      • getStepName

        public java.lang.String getStepName()
                             throws VWException
        Deprecated. 
        Gets the step name for this instance.
        Returns:
        A String containing the step name, or null if the step does not exist.
        Throws:
        VWException - Thrown when the step name cannot be found.

      • getServerLocation

        public int getServerLocation()
                      throws VWException
        Deprecated. 
        Gets the current server location of the work object.
        Returns:
        Number of the server for the work object
        Throws:
        VWException

      • checkSession

        public boolean checkSession(boolean throwException)
                     throws VWException
        Check to verify the session exists. If the object has been serialized, the session would be null.
        Parameters:
        Set - throwException to true, if exception for null session should be thrown.
        Returns:
        Return false is the session is null, otherwise true.
        Throws:
        VWException
        Since:
        P8 5.3
Skip navigation links
Process API

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