Process Class Relationships

filenet.vw.api
Class VWRuleSetDefinition

java.lang.Object
  |
  +--filenet.vw.api.VWRuleSetDefinition
All Implemented Interfaces:
java.io.Serializable

public final class VWRuleSetDefinition
extends java.lang.Object
implements java.io.Serializable

This class encapsulates a ruleset object, which enables business rules to be independently applied to workflows.

Since:
VWWS3.10
See Also:
VWStepDefinition, VWWorkflowDefinition, Serialized Form

Method Summary
 java.lang.String getValue()
          Gets the value of this rule set.
 void setValue(java.lang.String theValue)
          Sets the value for the rule set.
 java.lang.String toString()
          Gets the value of the rule set.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML String that represents this VWRuleSetDefinition object to the buffer specified by the input parameter.
 void validate(VWSession theSession, java.util.Vector EDefVector)
          Validates this VWRuleSetDefinition object, by updating the specified Vector with any validation errors found.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getValue

public java.lang.String getValue()
Gets the value of this rule set.
Returns:
The value of this rule set.

setValue

public void setValue(java.lang.String theValue)
              throws VWException
Sets the value for the rule set. The value must be unique.
Parameters:
theValue - a String expression.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML String that represents this VWRuleSetDefinition object to the buffer specified by the input parameter.

Warning: This XML String is non-extensible, and cannot be modified in any way.

Parameters:
theBuffer - A String buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

validate

public void validate(VWSession theSession,
                     java.util.Vector EDefVector)
              throws VWException
Validates this VWRuleSetDefinition object, by updating the specified Vector with any validation errors found.
Parameters:
theSession - The current session object
EDefVector - a Vector that will hold any new VWValidationErrors found.
Note:
The Vector may already contain some validation errors from previous validation calls for other objects
Throws:
VWException - Thrown if an error occurs that is encountered as part of the validation.

toString

public java.lang.String toString()
Gets the value of the rule set.
Overrides:
toString in class java.lang.Object
Returns:
A String containing the value of the rule set.


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.