Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE
Class PolicyActionComposite

The PolicyActionComposite class is the base class for serving as a generic container in which to place PolicyActionAtomic, PolicyActionVendor, or PolicyActionComposite classes. The first two provide actions that this container groups, while the latter establishes a hierarchy in which to order the execution of PolicyActions.

Both simple as well as complex PolicyActions can be placed in this container.

Each PolicyActionAtomic and PolicyActionVendor object is linked to this object using the containedPolicyActions association.

Attributes
Integer actionExecutionStrategy actionExecutionStrategy

This is an enumerated integer that defines the execution strategy to be used upon the sequenced actions aggregated by this PolicyActionComposite object. 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 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.

Boolean actionsCNF actionsCNF
Integer actionSequence actionSequence

This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure.
For example if a composite is part of another composite policy structure.

Notes: default is “1”

Boolean hasSubPolicyActions hasSubPolicyActions

This is a Boolean attribute that, if TRUE, signifies that this PolicyAction has one or more sub-actions. Sub-actions are used to enforce a hierarchical nesting of actions, so that parent actions may control the evaluation and other semantics of sub-actions that they contain.

Notes: Not present in the ITU or CIM specs.

Attributes inherited from SID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyAction SID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyAction
_policyRuleBase _policyRuleBase, _policyAction _policyAction, _policyAction1 _policyAction1, _policyActionSpec _policyActionSpec, _revenueAssuranceConsequence _revenueAssuranceConsequence, policyRule policyRule, policyAction policyAction, policyAction2 policyAction2

Attributes inherited from SID Models::Common Domain::Policy ABE::Policy Framework ABE::Policy SID Models::Common Domain::Policy ABE::Policy Framework ABE::Policy
_policyApplication _policyApplication, keywords keywords, policyName policyName, _policyRepository _policyRepository, _policyDomain _policyDomain

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
NamePolicyActionComposite
Name Expression
NamespacePolicy Action ABE
Owned Template Signature
OwnerPolicy Action ABE
Owning Template Parameter
PackagePolicy Action ABE
Qualified NameSID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyActionComposite
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 actionExecutionStrategy
Public Integer actionExecutionStrategy

This is an enumerated integer that defines the execution strategy to be used upon the sequenced actions aggregated by this PolicyActionComposite object. 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 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
ClassPolicyActionComposite
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)
NameactionExecutionStrategy
Name Expression
NamespacePolicyActionComposite
Opposite
OwnerPolicyActionComposite
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyActionComposite::actionExecutionStrategy
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value
VisibilityPublic


 actionsCNF
Public Boolean actionsCNF
Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPolicyActionComposite
Datatype
Defaulttrue
Default Value(true)
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NameactionsCNF
Name Expression
NamespacePolicyActionComposite
Opposite
OwnerPolicyActionComposite
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyActionComposite::actionsCNF
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value
VisibilityPublic


 actionSequence
Public Integer actionSequence

This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure.
For example if a composite is part of another composite policy structure.

Notes: default is “1”

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPolicyActionComposite
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)
NameactionSequence
Name Expression
NamespacePolicyActionComposite
Opposite
OwnerPolicyActionComposite
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyActionComposite::actionSequence
Stereotyperequired
Template Parameter
TypeInteger
Upper1
Upper Value
VisibilityPublic


 hasSubPolicyActions
Public Boolean hasSubPolicyActions

This is a Boolean attribute that, if TRUE, signifies that this PolicyAction has one or more sub-actions. Sub-actions are used to enforce a hierarchical nesting of actions, so that parent actions may control the evaluation and other semantics of sub-actions that they contain.

Notes: Not present in the ITU or CIM specs.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPolicyActionComposite
Datatype
Defaultfalse
Default Value(false)
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NamehasSubPolicyActions
Name Expression
NamespacePolicyActionComposite
Opposite
OwnerPolicyActionComposite
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyActionComposite::hasSubPolicyActions
Stereotyperequired
Template Parameter
TypeBoolean
Upper1
Upper Value
VisibilityPublic