Common Domain::Policy ABE::Policy Framework Spec ABE
Class PolicyRuleSpec

This is a concrete base class that is used to define the invariant characteristics (attributes, methods, constraints and relationships) of a PolicyRule entity.

Attributes
PolicyRule _policyRule _policyRule
Integer executionStrategy executionStrategy

This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include:

0: Unknown
1: Do Until Success
2: Do All
3: Do Until Failure
4: Do All Without Failure or Do Nothing

"Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed).

"Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails.

"Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped.

Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered.

String policyActionSelectCriteria policyActionSelectCriteria

This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyActions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyActions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.

Notes: Not present in the ITU or CIM specs

String policyConditionSelectCriteria policyConditionSelectCriteria

This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyConditions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyConditions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.

Notes: Not present in the ITU or CIM specs.

String policyEventSelectCriteria policyEventSelectCriteria

This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.

Notes: Not present in the ITU or CIM specs.

PolicyRuleBase policyRuleBase policyRuleBase
Integer sequencedActions sequencedActions

This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted.

Notes: Not present in the ITU or CIM specs (the CIM defined a subset of these values as an attribute in the PolicyRule).

Attributes inherited from SID Models::Common Domain::Policy ABE::Policy Framework Spec ABE::PolicySetSpec SID Models::Common Domain::Policy ABE::Policy Framework Spec ABE::PolicySetSpec
decisionStrategy decisionStrategy, _policySet _policySet

Attributes inherited from SID Models::Common Domain::Root Business Entities ABE::EntitySpecification SID Models::Common Domain::Root Business Entities ABE::EntitySpecification
_entityIdentificationSpecification _entityIdentificationSpecification, _entitySpecCharUse _entitySpecCharUse, _metricDefinition _metricDefinition, externalSystemCapability externalSystemCapability, entitySpecificationAction entitySpecificationAction, entitySpecificationType entitySpecificationType, validFor validFor, status status

Attributes inherited from SID Models::Common Domain::Root Business Entities ABE::RootEntity SID Models::Common Domain::Root Business Entities ABE::RootEntity
_rootEntityType _rootEntityType, _revenueAssuranceParmValue _revenueAssuranceParmValue, _characteristicValue _characteristicValue, name name, description description, ID ID, metric metric, _monitoredMetricInstancesCriteria _monitoredMetricInstancesCriteria, directedEdge directedEdge, vertex vertex, entityCatalogItem entityCatalogItem, rootEntityGroupMember rootEntityGroupMember, rootEntityGroup rootEntityGroup, rootEntityRelationship rootEntityRelationship, rootEntityRelationship2 rootEntityRelationship2, associationRole associationRole, entitySpecificationAttachment entitySpecificationAttachment, interactionUseCase interactionUseCase, interactionResult interactionResult

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NamePolicyRuleSpec
Name Expression
NamespacePolicy Framework Spec ABE
Owned Template Signature
OwnerPolicy Framework Spec ABE
Owning Template Parameter
PackagePolicy Framework Spec ABE
Qualified NameSID Models::Common Domain::Policy ABE::Policy Framework Spec ABE::PolicyRuleSpec
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 _policyRule
Public PolicyRule _policyRule
Constraints:
Properties:

AggregationShared
Alias
AssociationSpecifiesPolicyRule
Association End
ClassPolicyRuleSpec
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquefalse
Keywords
Lower0
Lower Value(0)
Multiplicity*
Name_policyRule
Name Expression
NamespacePolicyRuleSpec
Opposite_policyRuleSpec
OwnerPolicyRuleSpec
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Framework Spec ABE::PolicyRuleSpec::_policyRule
Stereotype
Template Parameter
TypePolicyRule
Upper*
Upper Value(*)
VisibilityPublic


 executionStrategy
Public Integer executionStrategy

This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include:

0: Unknown
1: Do Until Success
2: Do All
3: Do Until Failure
4: Do All Without Failure or Do Nothing

"Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed).

"Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails.

"Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped.

Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPolicyRuleSpec
Datatype
Default2
Default Value()
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NameexecutionStrategy
Name Expression
NamespacePolicyRuleSpec
Opposite
OwnerPolicyRuleSpec
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Framework Spec ABE::PolicyRuleSpec::executionStrategy
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value
VisibilityPublic


 policyActionSelectCriteria
Public String policyActionSelectCriteria

This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyActions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyActions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.

Notes: Not present in the ITU or CIM specs

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPolicyRuleSpec
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NamepolicyActionSelectCriteria
Name Expression
NamespacePolicyRuleSpec
Opposite
OwnerPolicyRuleSpec
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Framework Spec ABE::PolicyRuleSpec::policyActionSelectCriteria
Stereotyperequired
Template Parameter
TypeString
Upper1
Upper Value
VisibilityPublic


 policyConditionSelectCriteria
Public String policyConditionSelectCriteria

This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyConditions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyConditions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.

Notes: Not present in the ITU or CIM specs.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPolicyRuleSpec
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NamepolicyConditionSelectCriteria
Name Expression
NamespacePolicyRuleSpec
Opposite
OwnerPolicyRuleSpec
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Framework Spec ABE::PolicyRuleSpec::policyConditionSelectCriteria
Stereotyperequired
Template Parameter
TypeString
Upper1
Upper Value
VisibilityPublic


 policyEventSelectCriteria
Public String policyEventSelectCriteria

This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.

Notes: Not present in the ITU or CIM specs.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPolicyRuleSpec
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NamepolicyEventSelectCriteria
Name Expression
NamespacePolicyRuleSpec
Opposite
OwnerPolicyRuleSpec
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Framework Spec ABE::PolicyRuleSpec::policyEventSelectCriteria
Stereotyperequired
Template Parameter
TypeString
Upper1
Upper Value
VisibilityPublic


 policyRuleBase
Public PolicyRuleBase policyRuleBase
Constraints:
Properties:

AggregationShared
Alias
AssociationSpecifiesPolicRule
Association End
ClassPolicyRuleSpec
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamepolicyRuleBase
Name Expression
NamespacePolicyRuleSpec
OppositepolicyRuleSpec
OwnerPolicyRuleSpec
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Framework Spec ABE::PolicyRuleSpec::policyRuleBase
Stereotype
Template Parameter
TypePolicyRuleBase
Upper*
Upper Value(*)
VisibilityPublic


 sequencedActions
Public Integer sequencedActions

This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted.

Notes: Not present in the ITU or CIM specs (the CIM defined a subset of these values as an attribute in the PolicyRule).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPolicyRuleSpec
Datatype
Default1
Default Value()
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NamesequencedActions
Name Expression
NamespacePolicyRuleSpec
Opposite
OwnerPolicyRuleSpec
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Framework Spec ABE::PolicyRuleSpec::sequencedActions
Stereotyperequired
Template Parameter
TypeInteger
Upper1
Upper Value
VisibilityPublic