filenet.vw.api

Class VWRuleSetDefinition

java.lang.Object

filenet.vw.api.VWRuleSetDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Enables business rules to be independently applied to workflows.

Since:

VWWS3.10

See Also:

VWStepDefinition, VWWorkflowDefinition, Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a clone of this instance.
boolean	getExpensive() Indicates whether asynchronous execution of this rule set is permitted.
java.lang.String	getName() Gets the name of this rule set.
java.lang.String	getValue() Deprecated. 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.
void	setExpensive(boolean expensive) Permits asynchronous execution of this instance.
void	setName(java.lang.String theName) Sets the name for this instance.
void	setValue(java.lang.String theValue) Deprecated. 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.
java.lang.String	toString() Gets the value of this rule set.
void	toXML(java.lang.StringBuffer theBuffer) Deprecated. Use VWWorkflowDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.writeToFile(String).
void	validate(VWSession theSession, java.util.Vector EDefVector) Validates this instance, appending any validation errors found to the specified Vector object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getValue

public java.lang.String getValue()

Deprecated. 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.

getName

public java.lang.String getName()

Gets the name of this rule set. If a translation source exists, the authored name is translated.

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

Returns:

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

setValue

public void setValue(java.lang.String theValue)
              throws VWException

Deprecated. 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.

Throws:

VWException

setName

public void setName(java.lang.String theName)
             throws VWException

Sets the name for this instance. The name must be unique among all rule sets in the containing workflow.

Parameters:

theName - A String containing the name for the rule set.

Throws:

VWException

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException

Deprecated. Use VWWorkflowDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.writeToFile(String).

Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Parameters:

theBuffer - A StringBuffer that will be appended with the XML content.

Throws:

VWException - Thrown if the specified buffer is null.

See Also:

VWWorkflowDefinition

validate

public void validate(VWSession theSession,
            java.util.Vector EDefVector)
              throws VWException

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.

setExpensive

public void setExpensive(boolean expensive)
                  throws VWException

Permits asynchronous execution of this instance. Use this method if the rule can take a relatively long time to execute.

A rule set is considered expensive if it cannot be executed by the rules engine in less than one second.

Indicating the rule set is expensive can improve system response time by ensuring that the Process Engine server's RPC handling processes are not waiting for a response from the rules engine. However, background processing and the work item queueing required to execute rule sets asynchronously increases overhead. You should balance these competing processing expenses for appropriate overall performance.

Parameters:

expensive - A boolean value of true to indicate the rule set is to be executed asynchronously; otherwise, false.

Throws:

VWException - Thrown if an error occurs.

getExpensive

public boolean getExpensive()
                     throws VWException

Indicates whether asynchronous execution of this rule set is permitted.

Returns:

A boolean value of true if asynchronous execution is allowed; otherwise false.

Throws:

VWException - Thrown if an error occurs.

See Also:

setExpensive

toString

public java.lang.String toString()

Gets the value of this rule set.

Overrides:

toString in class java.lang.Object

Returns:

A String containing the value of the rule set.

clone

public java.lang.Object clone()

Creates a clone of this instance.

Overrides:

clone in class java.lang.Object

Returns:

An Object clone of this instance.