com.pega.pegarules.pub.util

Interface RuleSetSpecification

All Superinterfaces:

java.lang.Comparable

All Known Subinterfaces:

RuleSet

public interface RuleSetSpecification
extends java.lang.Comparable

An immutable representation of a ruleset specification. A ruleset specification corresponds to one or more specific ruleset versions.

The text representation of a ruleset specification looks like

name[:[(xx[-yy[-zz]]) | *]]

where xx, yy, and zz are two-digit numbers.

The following are valid ruleset specifications:

My-Ruleset

Represents any version of ruleset My-Ruleset.

My-Ruleset:

Represents any version of ruleset My-Ruleset.

My-Ruleset:*

Represents any version of ruleset My-Ruleset.

My-Ruleset:02

Represents any version of ruleset My-Ruleset with major version 2.

My-Ruleset:02-03

Represents any version of ruleset My-Ruleset with major version 2 and minor version 3 or below.

My-Ruleset:02-03-04

Represents any version of ruleset My-Ruleset with major version 2 and and minor and revision version at or below 3.4.

The toString method returns a standard string representation of this ruleset specification.

A RulesetSpecification object does not describe anything about the tenant (or shared) context of the ruleset. It is possible to have the same ruleset name and version exist in 2 different tenants with different types (e.g. Validation type). This object does not distinguish which tenant it is associated with

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	sBaseRulesetName The "base" RuleSet name.
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
boolean	compareNameAndMajorVersion(java.lang.Object aOther) Compares another ruleset's name and major version to this ruleset.
int	compareTo(java.lang.Object aRuleSet) Compares another ruleset to this.
boolean	equals(java.lang.Object aRuleset) Returns true iff this and the given ruleset instance describe the same ruleset.
java.lang.String	getBranchName() If this is a branched ruleset, returns the branch name.
java.lang.String	getBranchOriginName() If this is a branched ruleset, returns the origin ruleset name.
java.lang.String	getLocalePattern() Other parts of PRPC need to the locale pattern of a ruleset yet don't want to parse the name again.
int	getMajorVersion() Gets the major version.
int	getMinorVersion() Gets the minor version.
java.lang.String	getName() Returns the ruleset name.
int	getRevision() Gets the revision.
java.lang.String	getRuleSetType()
java.lang.String	getVersionString() Returns the version, as a string.
boolean	isLocalized() This method tells if the ruleset is a localized.
boolean	isMobilized() This method tells if the ruleset is a mobilized.
boolean	isPersonal() if this ruleset is a personal one (contains an '@') return true.
boolean	isRulesetApplicationBasedValidation() Tells us if this ruleset uses AppBasedValidation
boolean	isRulesetIncluded(RuleSetSpecification aRuleset) Returns true if this ruleset includes the given specification.
boolean	isTypeBranch()
boolean	isTypeBranchPegaOrPega() Pega ruleset names start with "Pega-"
boolean	isTypeComponent()
boolean	isTypeOverride() Please note Override rulesets are discouraged in release 6.3 & up
boolean	isTypePega()
boolean	isTypePegaFW()
boolean	isTypeProduction() Note: This returns the value of the Ruleset category & type - which is not used to indicate whether a ruleset is being as a Production Ruleset from an Access Group.
boolean	isTypeShared()
boolean	isTypeStandard()

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

sBaseRulesetName

static final java.lang.String sBaseRulesetName

The "base" RuleSet name.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the ruleset name.

Returns:

the name

getBranchName

java.lang.String getBranchName()

If this is a branched ruleset, returns the branch name.

Returns:

the name

getBranchOriginName

java.lang.String getBranchOriginName()

If this is a branched ruleset, returns the origin ruleset name.

Returns:

the name

getMajorVersion

int getMajorVersion()

Gets the major version.

Returns:

the major version number, or a negative number if none is specified

getMinorVersion

int getMinorVersion()

Gets the minor version.

Returns:

the minor version number, or a negative number if none is specified

getRevision

int getRevision()

Gets the revision.

Returns:

the revision version number, or a negative number if none is specified

isPersonal

boolean isPersonal()

if this ruleset is a personal one (contains an '@') return true.

Returns:

true if the rulesetname contains an '@', false otherwise

compareTo

int compareTo(java.lang.Object aRuleSet)

Compares another ruleset to this. Both rulesets must have the same name.

This method and all other comparison methods such as equals(), hashCode(), isRulesetInlcuded() do not compare anything related to the tenant id. RuleSetSpecifications are not tenantized. It is assumed that higher layers of the application will differentiate on tenant id

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

aRuleSet - the ruleset to compare to this

Returns:

a positive number if this has a higher version than aRuleset; zero if they are the same version; or a negative number if aRuleset has a higher version

compareNameAndMajorVersion

boolean compareNameAndMajorVersion(java.lang.Object aOther)

Compares another ruleset's name and major version to this ruleset.

This method and all other comparison methods such as equals(), hashCode(), isRulesetInlcuded() do not compare anything related to the tenant id. RuleSetSpecifications are not tenantized. It is assumed that higher layers of the application will differentiate on tenant id

Parameters:

aOther - the ruleset to compare to this

Returns:

true iff both name and major version are the same

equals

boolean equals(java.lang.Object aRuleset)

Returns true iff this and the given ruleset instance describe the same ruleset.

This method and all other comparison methods such as equals(), hashCode(), isRulesetInlcuded() do not compare anything related to the tenant id. RuleSetSpecifications are not tenantized. It is assumed that higher layers of the application will differentiate on tenant id

Overrides:

equals in class java.lang.Object

Parameters:

aRuleset - the ruleset to compare this to. This must be a RuleSetSpecification or another RuleSet. If it is a RuleSetSpecification, then it is equal to this ruleset only if it has all three version parts specified, they match the version parts of this ruleset.

Returns:

true iff the two instances describe the same RuleSet

isRulesetIncluded

boolean isRulesetIncluded(RuleSetSpecification aRuleset)

Returns true if this ruleset includes the given specification.

This method and all other comparison methods such as equals(), hashCode(), isRulesetInlcuded() do not compare anything related to the tenant id. RuleSetSpecifications are not tenantized. It is assumed that higher layers of the application will differentiate on tenant id

Parameters:

aRuleset - the ruleset to check

Returns:

result

getVersionString

java.lang.String getVersionString()

Returns the version, as a string.

Returns:

the version (not including the colon). For example, for a RuleSet specification My-RuleSet:02-03, 02-03 would be returned. If the specification does not include any version information, then an empty string is returned.

isTypeOverride

boolean isTypeOverride()

Please note Override rulesets are discouraged in release 6.3 & up

Returns:

true if this is an Override rulesets

isTypeBranch

boolean isTypeBranch()

Returns:

true if this is a branch ruleset

isTypeStandard

boolean isTypeStandard()

Returns:

true if this is a standard ruleset

getRuleSetType

java.lang.String getRuleSetType()

Returns:

the Ruleset type as a String. This matches the type displayed on the Category Tab of theRule-Ruleset-Name form.

isTypeShared

boolean isTypeShared()

Returns:

true if this is a Shared ruleset

isTypeComponent

boolean isTypeComponent()

Returns:

true if this is a Component ruleset

isTypePega

boolean isTypePega()

Returns:

true if this is a Pega ruleset

isTypePegaFW

boolean isTypePegaFW()

Returns:

true if this is a Pega Framework ruleset

isTypeProduction

boolean isTypeProduction()

Note: This returns the value of the Ruleset category & type - which is not used to indicate whether a ruleset is being as a Production Ruleset from an Access Group. To find the production rulesets involved in a Ruleset list, use the definition from the access group. Not this method.

Returns:

always returns false;

isTypeBranchPegaOrPega

boolean isTypeBranchPegaOrPega()

Pega ruleset names start with "Pega-"

Returns:

true if this is a Pega ruleset or it's a branch of a Pega ruleset

isLocalized

boolean isLocalized()

This method tells if the ruleset is a localized. The answer is derived by the naming pattern. note: The implementation uses the LocaleUtils from apache common library while others may not so there is a possibility that other part of PRPC may give a different answer based on the same input. Yet we think this usage of open source common library makes better sense.

Returns:

true if this ruleset is localized; false otherwise

isMobilized

boolean isMobilized()

This method tells if the ruleset is a mobilized. The answer is derived by the naming pattern.

Returns:

true if this ruleset is mobilized; false otherwise

getLocalePattern

java.lang.String getLocalePattern()

Other parts of PRPC need to the locale pattern of a ruleset yet don't want to parse the name again. Since we do parse it here, let it remember the pattern.

Returns:

the locale pattern of this ruleset

isRulesetApplicationBasedValidation

boolean isRulesetApplicationBasedValidation()

Tells us if this ruleset uses AppBasedValidation

Returns:

true if we use app based validation.