filenet.vw.api

Class VWMapNode

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

    • Field Detail

      • PRE_RULESETS

        public static final int PRE_RULESETS
        Indicates a type of ruleset that is executed before a user gets the work object. Used with #getRuleSets(int) and #setRuleSets(int, VWRuleSetDefinition []).
        See Also:
        Constant Field Values

      • UPDATE_RULESETS

        public static final int UPDATE_RULESETS
        Indicates a type of ruleset that is executed when the work object is saved. Used with #getRuleSets(int) and #setRuleSets(int, VWRuleSetDefinition []).
        See Also:
        Constant Field Values

      • POST_RULESETS

        public static final int POST_RULESETS
        Indicates a type of ruleset that is executed the work object is dispatched. Used with #getRuleSets(int) and #setRuleSets(int, VWRuleSetDefinition []).
        See Also:
        Constant Field Values

    • Method Detail

      • validate

        public abstract void validate(VWSession theSession,
                              java.util.Vector EDefVector)
                       throws VWException
        Deprecated. Use VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)
        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.

        Throws:
        VWException - Thrown if an error occurs during the validation.

      • toString

        public abstract java.lang.String toString()
        Returns a string representation of this map node object, typically used for debug echo statements.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this map node object

      • getAuthoredName

        public java.lang.String getAuthoredName()
        Gets the authored name of this step.
        Returns:
        A String containing the authored name of this step.
        Since:
        PE 4.5.1

      • getName

        public java.lang.String getName()
        Gets the value of the current node's name property.
        Returns:
        Name of the current node

      • setName

        public void setName(java.lang.String theName)
             throws VWException
        Sets the value of the current node's name property.
        Parameters:
        theName - New name of the current node
        Throws:
        VWException - Thrown if the name is null or invalid

      • getDescription

        public java.lang.String getDescription()
        Gets the value of the current node's description property.
        Returns:
        Description of the current node: null if the description is null

      • setDescription

        public void setDescription(java.lang.String theDescription)
        Sets the value of the current node's description property.
        Parameters:
        theDescription - New description of the current node

      • setDocumentation

        public void setDocumentation(java.lang.String theDocumentation)
        Sets the value of the current node's documentation property.
        Parameters:
        theDocumentation - A String containing the documentation of the current node.

      • getDocumentation

        public java.lang.String getDocumentation()
        Gets the value of the current node's documentation property.
        Returns:
        A String containing the documentation of the current node, or null if no documentation is specified.

      • setAuthorTool

        public void setAuthorTool(java.lang.String s)
        Sets the value of the current node's authoring tool property.
        Parameters:
        s - A String containing the authoring tool assigned to the current node.

      • getAuthorTool

        public java.lang.String getAuthorTool()
        Gets the value of the current node's authoring tool property.
        Returns:
        A String identifying the authoring tool assigned to the current node, or null if no authoring tool is specified.

      • getStepId

        public int getStepId()
        Gets the value of this step's stepId property.
        Returns:
        Step ID
        See Also:
        VWMapDefinition

      • getLocation

        public java.awt.Point getLocation()
        Gets the value of the location property associated with this step.
        Returns:
        Location of this step; null if there is value set for the location property of this VWMapNode object.

      • setLocation

        public void setLocation(java.awt.Point theLocation)
        Sets the value of the location property associated with this step.
        Parameters:
        theLocation - New location of this step

      • getSplitType

        public int getSplitType()
        Gets the step's split type.
        Returns:
        Integer value of the step's SplitType property.
        See Also:
        VWSplitType

      • setSplitType

        public void setSplitType(int theSplitType)
                  throws VWException
        Sets the value of this step's SplitType property.
        Parameters:
        theSplitType - New split type for this step definition
        Throws:
        VWException - Thrown if the split type is invalid
        See Also:
        VWSplitType.field_summary

      • getJoinType

        public int getJoinType()
        Gets the value of this step's JoinType property.
        Returns:
        An integer value that represents the join type of this step
        See Also:
        VWJoinType

      • setJoinType

        public void setJoinType(int theJoinType)
                 throws VWException
        Sets the value of this step's JoinType property.
        Parameters:
        theJoinType - New join type of this step
        Throws:
        VWException - Thrown if the join type is invalid
        See Also:
        VWJoinType

      • setAttributeInfo

        public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
        Sets a VWAttribute object containing attributes for this object.
        Parameters:
        theAttributeInfo - A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
        Throws:
        VWException
        See Also:
        VWMapNode.getAttributeInfo()

      • deleteRoute

        public void deleteRoute(int theRouteId)
                 throws VWException
        Deletes an outbound route from this step.
        Parameters:
        theRouteId - ID of the route to be deleted
        Throws:
        VWException - Thrown if the system does not find the specified route ID, or the ID does not originate with this step
        See Also:
        VWRouteDefinition

      • createRoute

        public VWRouteDefinition createRoute(int theDestinationId)
                              throws VWException
        Creates an outbound route for the current step. This step will be the implicit source step for the route.

        Note: When you call VWMapNode.getNextRoutes() after createRoute, by default this method returns routes in the order in which they were created. You can alter this order by calling VWMapNode.reorderRoutes(int[]).

        Parameters:
        theDestinationId - An int indicating the ID of the destination step of the new route.
        Returns:
        A VWRouteDefinition object identifying the newly created route.
        Throws:
        VWException - Thrown if there is an error during route creation.
        See Also:
        VWRouteDefinition

      • getNextRoutes

        public VWRouteDefinition[] getNextRoutes()
                                  throws VWException
        Gets the definition of each outbound route associated with the current node.
        Returns:
        An array of VWRouteDefinition objects identifying the outbound route definitions for the current node at runtime. The object array is ordered according to the order in which the system evaluated the conditions associated with the routes.

        Note: Null is returned if there is no outbound route defined.

        Throws:
        VWException
        See Also:
        VWRouteDefinition, VWMapNode.createRoute(int), VWMapNode.reorderRoutes(int[])

      • getRoute

        public VWRouteDefinition getRoute(int theRouteId)
                           throws VWException
        Gets the route definition for the route ID specified.
        Parameters:
        theRouteId - An int indicating the ID of the route definition.
        Returns:
        The VWRouteDefinition object identified by the specified route ID.
        Throws:
        VWException
        See Also:
        VWRouteDefinition

      • getRouteFrom

        public VWRouteDefinition getRouteFrom(int theSourceStepId)
                               throws VWException
        Gets the inbound route from another step.
        Parameters:
        theSourceStepId -
        Returns:
        Definition of the route from the step you specify, or null if there is no inbound route from the source step.
        Throws:
        VWException
        See Also:
        VWRouteDefinition

      • getRouteTo

        public VWRouteDefinition getRouteTo(int theDestinationStepId)
                             throws VWException
        Gets the outbound route to another step.
        Parameters:
        theDestinationStepId -
        Returns:
        Definition of the route to the step you specify, or null if there is no outbound route
        Throws:
        VWException
        See Also:
        VWRouteDefinition

      • reorderRoutes

        public void reorderRoutes(int[] theRouteOrder)
                   throws VWException
        Changes the order in which the system stores outbound routes in this map node. At runtime, the system evaluates conditions attached to outbound routes in the order in which it stores routes. This method allows the caller to change that order.

        When the user calls the VWMapNode.getNextRoutes() method, the routes are returned in the order in which they are stored, which, by default, is the order is the order in which they were created, unless the user calls this method to change that order.

        Parameters:
        theRouteOrder - Array of integers, which you set to contain one route ID integer for each route in this step. The order of the route IDs in the array is the new order for the outbound routes.

        Use a route ID value only once in the array. Determine the number of routes in a step by calling the getNextRoutes method and checking the length of the returned array of routes.

        Throws:
        VWException - Thrown if the input parameter (theRouteOrder) that defines the order of routes is invalid. This could result from that parameter having the wrong number of elements or an inconsistent content.
        See Also:
        VWRouteDefinition, VWMapNode.getNextRoutes(), VWMapNode.createRoute(int)

      • getNodeType

        public int getNodeType()
        Returns the value of the map node type.
        Returns:
        The value of the node type, as defined in the VWNodeType class.
        See Also:
        VWNodeType

      • getSession

        public VWSession getSession()
                     throws VWException
        Get the session associated with this mapnode definition.
        Returns:
        The session associated with this mapnode definition, may return null.
        Throws:
        VWException
Skip navigation links
Process API

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