filenet.vw.api

Class VWFaultDefinition

  • java.lang.Object
    • filenet.vw.api.VWFaultDefinition
  • All Implemented Interfaces:
    java.io.Serializable

    public final class VWFaultDefinition
extends java.lang.Object
implements java.io.Serializable
    Use the VWFaultDefinition class to retrieve and set the name, map name (optional), and message for a Web Services fault, represented by a VWFaultDefinition object. Additional functions of methods in this class include validating a fault or converting a fault into an XML String.
    See Also:
    VWCompoundStepDefinition, VWValidationError, VWInvokeInstruction, Serialized Form

    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the name of this fault definition. If a translation source exists, the authored name of this instance is translated.

        Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

        Returns:
        A String containing the translated name of this instance, if a translation source exists; otherwise the authored name is returned.

      • getFaultMapName

        public java.lang.String getFaultMapName()
        Gets the fault map name for this instance. If a translation source exists, the authored name of the field is translated.

        Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

        Returns:
        A String containing the translated fault map name, if a translation source exists; otherwise the authored name is returned.

      • getFaultMessage

        public java.lang.String getFaultMessage()
        Gets the fault message for this instance. If a translation source exists, the authored message is translated.

        Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

        Returns:
        A String containing the translated fault message, if a translation source exists; otherwise the authored message is returned.

      • setName

        public void setName(java.lang.String theName)
             throws VWException
        Sets the name of this fault definition, which must be unique (within the containing invoke instruction), non-null, and non-empty.
        Parameters:
        theName - the new name for this fault definition
        Throws:
        VWException

      • setFaultMapName

        public void setFaultMapName(java.lang.String theFaultMapName)
        Sets the fault map name of this fault definition.
        Parameters:
        theFaultMapName - the new fault map name for this fault definition; may be null if no fault map is used.

      • setFaultMessage

        public void setFaultMessage(java.lang.String theFaultMessage)
        Sets the fault message of this fault definition.
        Parameters:
        theFaultMessage - the new fault message for this fault definition; must be a valid, non-null, LValue String expression (able to hold a value on the left side of an assignment statement).

      • validate

        public void validate(VWSession theSession,
                     java.util.Vector EDefVector,
                     VWCompoundStepDefinition myStep,
                     int instId,
                     int faultId)
              throws VWException
        Deprecated. Use VWWorkflowDefinition or VWWorkflowCollectionDefinition validate methods.
        Validates this instance, appending any validation errors found to the specified Vector object. Although this method does not return a value, EDefVector will be updated to contain any validation errors found.
        Parameters:
        theSession - The current VWSession object if logged on. This is needed for various parts of the validation process. This can be null; however, areas of validation requiring a logon will not be validated.
        EDefVector - A Vector to which will be added a VWValidationError object for each validation error found. This can be null; in this case, a new Vector is used.

        Note: Because validate methods having EDefVector in the signature also occur on other classes, the existing Vector can contain validation errors from previous validation calls.

        myStep - The VWCompoundStepDefinition object containing this event.
        instId - An integer identifying the instruction ID for the VWInvokeInstruction object that contains this event.
        faultId - An integer identifying the fault ID of this fault (its index into the array of faults that belongs to the containing VWInvokeInstruction object), or -99. A value of -99 represents the catch all fault definition. Other index values are useful for accessing meaningful validation error messages within the array of faults in the containing invoke instruction.
        Throws:
        VWException - Thrown if an error occurs during the validation.
        See Also:
        VWCompoundStepDefinition, VWValidationError, VWInvokeInstruction

      • getSession

        public VWSession getSession()
                     throws VWException
        Get the session associated with this event definition.
        Returns:
        The session associated with this event definition, may return null.
        Throws:
        VWException
Skip navigation links
Process API
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

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