com.pega.pegarules.pub.database

Class CircumstanceResult

java.lang.Object

com.pega.pegarules.pub.database.CircumstanceResult

Deprecated.

public final class CircumstanceResult
extends java.lang.Object

This represents the results of rule resolution for a particular circumstance value. It is used when resolving a rule without considering circumstance.

An instance of this class consists of a status (an instance of CircumstanceResult.Status) and a clipboard page. There are three possibilities:

• There was a single rule version found for the circumstance value. In this case, the status is CircumstanceResult.Status.oGood and the clipboard page is the rule version.
• All the rule versions found for the circumstance value are blocked. Here, the status is CircumstanceResult.Status.oBlocked and the clipboard page is one of the blocked rule versions.
• There was more than one version found for the circumstance value. The status is CircumstanceResult.Status.oMultipleVersions and the clipboard page is one of the versions.

In addition, instances of this class can report on the circumstance property (assuming there is only one) and the expiration date for the result.

Version:

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

Author:

Jamie Gentry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CircumstanceResult.Status Deprecated. The possible results for resolving a rule for a specific circumstance.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT Deprecated.
static java.lang.String	VERSION Deprecated.

Constructor Summary

Constructors

Constructor and Description
CircumstanceResult(CircumstanceResult.Status aStatus, ClipboardPage aVersion, java.lang.String aCircumstanceProperty, java.util.Date aExpirationDate) Deprecated. Creates a result.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCircumstanceProperty() Deprecated. What is the circumstance property for this result?
java.util.Date	getExpirationDate() Deprecated. What is the expiration date for this result?
CircumstanceResult.Status	getStatus() Deprecated. Returns the status.
ClipboardPage	getVersion() Deprecated. Returns the version.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Deprecated.

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

Deprecated.

Constructor Detail

CircumstanceResult

public CircumstanceResult(CircumstanceResult.Status aStatus,
                  ClipboardPage aVersion,
                  java.lang.String aCircumstanceProperty,
                  java.util.Date aExpirationDate)

Deprecated.

Creates a result.

Parameters:

aStatus - the status

aVersion - the version

aCircumstanceProperty -

aExpirationDate -

Method Detail

getStatus

public CircumstanceResult.Status getStatus()

Deprecated.

Returns the status.

Returns:

the status

getVersion

public ClipboardPage getVersion()

Deprecated.

Returns the version.

Returns:

the version

getCircumstanceProperty

public java.lang.String getCircumstanceProperty()

Deprecated.

What is the circumstance property for this result?

Returns:

the name of the circumstance property

getExpirationDate

public java.util.Date getExpirationDate()

Deprecated.

What is the expiration date for this result?

Returns:

the expiration date