|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWRuleSetDefinition
public final class VWRuleSetDefinition
Enables business rules to be independently applied to workflows.
VWStepDefinition
,
VWWorkflowDefinition
,
Serialized FormMethod Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
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)
Appends an XML string representing this instance to the buffer specified. |
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 |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.lang.String getValue()
public java.lang.String getName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
public void setValue(java.lang.String theValue) throws VWException
VWException
public void setName(java.lang.String theName) throws VWException
theName
- A String containing the name for the rule set.
VWException
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
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.
VWException
- Thrown if an error occurs during the validation.public void setExpensive(boolean expensive) throws VWException
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.
expensive
- A boolean value of true to indicate the rule set is to be executed asynchronously; otherwise,
false.
VWException
- Thrown if an error occurs.public boolean getExpensive() throws VWException
VWException
- Thrown if an error occurs.setExpensive
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.Object clone()
clone
in class java.lang.Object
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |