com.pega.pegarules.pub.runtime
Interface CollectionRule

public interface CollectionRule

Represents a single Rule that is executed in a Collection.

Version:

$Revision: 31 $ $Date: 2009-06-24 09:38:04 -0400 (Wed, 24 Jun 2009) $

Author:

Jamie Gentry

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

java.lang.String	checkPrecondition() Tests the preconditions for this Rule.
java.lang.String	checkStopConditions() Performs a stop condition check for the containing Collection.
java.util.Date	getCircumstanceDateOverride() Returns the Circumstance Date Override value for this Collection step, or null if none.
java.lang.String	getCircumstanceOverride() Returns the Circumstance Override value for this Collection step, or null if none.
java.util.Date	getDateOverride() Returns the value to use as "now" for Rule Resolution, or null if the actual current value should be used.
StringMap	getRuleKeys() Returns the keys to this Rule.
java.lang.String	getRuleSetName() Returns the RuleSet associated with the Collection that contains this Rule step.
ParameterPage	getStepParams() If this Rule is an Activity or a Collection, returns the Parameters to be passed into the Activity.
void	performPresets() Performs Property presets for the containing Collection.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

See Also:

Constant Field Values

Method Detail

getRuleKeys

StringMap getRuleKeys()

Returns the keys to this Rule.

Returns:

the keys

getRuleSetName

java.lang.String getRuleSetName()

Returns the RuleSet associated with the Collection that contains this Rule step.

Returns:

the name of the RuleSet

getStepParams

ParameterPage getStepParams()

If this Rule is an Activity or a Collection, returns the Parameters to be passed into the Activity.

Returns:

the Parameters, or null if this is not an Activity or Collection call

checkStopConditions

java.lang.String checkStopConditions()

Performs a stop condition check for the containing Collection.

Returns:

null if no stop condition was hit, a string describing the situation if one was

performPresets

void performPresets()

Performs Property presets for the containing Collection.

checkPrecondition

java.lang.String checkPrecondition()

Tests the preconditions for this Rule.

Returns:

true if the precondition holds, a string describing the situation if it does not

getCircumstanceOverride

java.lang.String getCircumstanceOverride()

Returns the Circumstance Override value for this Collection step, or null if none.

Returns:

the value

getCircumstanceDateOverride

java.util.Date getCircumstanceDateOverride()

Returns the Circumstance Date Override value for this Collection step, or null if none.

Returns:

the value

getDateOverride

java.util.Date getDateOverride()

Returns the value to use as "now" for Rule Resolution, or null if the actual current value should be used.

Returns:

the value to use for now