Policy Action ABE UML Documentation

Element

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

This is the base class for all simple PolicyActions. A simple PolicyAction consists of a single Boolean clause, which is used to perform a single action. This consists of a single occurrence of a PolicyStatement, which is of the form:

{SET | CLEAR} PolicyVariable to PolicyValue

This is distinctly different from the PolicyActionVendor, which does not use a PolicyStatement.

PolicyActionAtomic objects can also be used to form more complex action structures. A PolicyActionComposite object can be used to contain a group of PolicyActionAtomic objects - this grouping enables multiple PolicyActionAtomic objects to be executed as a group. Alternatively, a PolicyActionAtomic object can contain one or more PolicyActionAtomic objects (and also PolicyActionComposite groups if desired) to provide the semantics of a compound PolicyAction. In either case, the aggregation is done using the containedPolicyActions aggregation.

Attributes
PolicyStatement	_policyStatement
Integer	actionSequenceNumber	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. This will allow a policy engine to reference externally supplied arguments to this object as it is executed. Notes: Not present in the ITU specs; CIM 2.7 has a subset of these values.
Integer	hasExecuted	This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction. Permited Values: 0: not yet executed 1: executed with no errors 2: executed with errors but successfully rolled back 3: executed with errors and did not roll back 4: did not complete execution but successfully rolled back 5: did not complete execution and did not roll back Notes: Not present in the ITU or CIM specs.
Boolean	hasSubActions	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 the 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
_policyRuleBase, _policyAction, _policyAction1, _policyActionSpec, _revenueAssuranceConsequence, policyRule, policyAction, policyAction2

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

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

Properties:

Alias
Classifier Behavior
Is Abstract	false
Is Active	false
Is Leaf	false
Keywords
Name	PolicyActionAtomic
Name Expression
Namespace	Policy Action ABE
Owned Template Signature
Owner	Policy Action ABE
Owning Template Parameter
Package	Policy Action ABE
Qualified Name	SID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyActionAtomic
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

_policyStatement

Public PolicyStatement _policyStatement

Constraints:

Properties:

Aggregation	Shared
Alias
Association	PolicyStatementInPolicyAction
Association End
Class	PolicyActionAtomic
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	false
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1
Name	_policyStatement
Name Expression
Namespace	PolicyActionAtomic
Opposite	_policyActionAtomic
Owner	PolicyActionAtomic
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyActionAtomic::_policyStatement
Stereotype
Template Parameter
Type	PolicyStatement
Upper	1
Upper Value	(1)
Visibility	Public

actionSequenceNumber

Public Integer actionSequenceNumber

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. This will allow a policy engine to reference externally supplied arguments to this object as it is executed.

Notes: Not present in the ITU specs; CIM 2.7 has a subset of these values.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PolicyActionAtomic
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	actionSequenceNumber
Name Expression
Namespace	PolicyActionAtomic
Opposite
Owner	PolicyActionAtomic
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyActionAtomic::actionSequenceNumber
Stereotype	required
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

hasExecuted

Public Integer hasExecuted

This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction.

Permited Values:
0: not yet executed
1: executed with no errors
2: executed with errors but successfully rolled back
3: executed with errors and did not roll back
4: did not complete execution but successfully rolled back
5: did not complete execution and did not roll back

Notes:
Not present in the ITU or CIM specs.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PolicyActionAtomic
Datatype
Default	0
Default Value	()
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	hasExecuted
Name Expression
Namespace	PolicyActionAtomic
Opposite
Owner	PolicyActionAtomic
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyActionAtomic::hasExecuted
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

hasSubActions

Public Boolean hasSubActions

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 the sub-actions that they contain.

Notes: Not present in the ITU or CIM specs.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PolicyActionAtomic
Datatype
Default	false
Default Value	(false)
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	hasSubActions
Name Expression
Namespace	PolicyActionAtomic
Opposite
Owner	PolicyActionAtomic
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Policy ABE::Policy Structure ABE::Policy Action ABE::PolicyActionAtomic::hasSubActions
Stereotype	required
Template Parameter
Type	Boolean
Upper	1
Upper Value
Visibility	Public

Overview

Top

Package

Element

Policy Action ABE UML Documentation

Summary:AttributesProperties

Detail:Attributes