BusinessContract

BusinessContract : public class

Created:	3/12/2005 12:00:00 AM
Modified:	7/27/2006 9:51:38 AM

Project:
Author:	AutoMagic KB LLC
Version:	6.2
Phase:	SID
Status:	Approved
Complexity:	Easy
Advanced:
UUID:	{821CC887-0D14-45f5-8D5D-46EC9CEE095B}
Appears In:	Entity Generalization Tree, Business Contract Generalization Tree, AMKB-BusinessInteraction, Contract - Obligations and Benefits, Fig 09 - Context, Fig 10 - ContractHeader, Fig 11 - Contract Generic Part, Fig 12 - Contract Functional Part, Fig 13 - Contract Non-Functional Part, Fig 14 - Mgmt Activities Field, Fig 15 - Mgmt Roles Field, Fig 17 - BusinessProcess Field, Fig 18 - BusinessPolicies Field, Fig 19 - ContractComposite, Fig 20 - ContractSpecificationTemp, Fig 21 - ContractSpecFinal, Fig 22 - Completed Basic Contract Structure, Fig 23 - Fig 22 Plus Obligations, Benefits, Goals and Activities, Fig 24 - Fig 23 Plus Delegations and Restrictions, Fig 25 - Fig 24 Plus Capabilities, Context, Policy and Process, Fig 26 - Fig 25 Plus Non-Functionals, Fig 27 - Fig 26 Plus Mgmt Part, Fig 31 - BusinessContracts and BusinessInteractions, Fig 36 - Contracts and Locations, Fig 38 - Contracts and Resources, Fig 40 - Contracts and Services, Fig 41 - Contracts and Products-Resources-Services, Fig 44 - Contract Biz Model

Copyright TM Forum 2005 This class implements the core contents of the business view of an NGOSS contract.

Attributes
Associations To
Associations From
Other Links

Attribute

Details

public String
contractGoal

Notes:

This is a string attribute, and defines the desired outcome achieved by this Business Contract.

public String
contractPurpose

Notes:

This is a string attribute that contains a free-form narrative describing the contract. Note that it does NOT override the inherited description attribute. This enables a Contract to have a business-specific purpose (contained in this attribute) as well as a generic, organization-wide description (if desired).

public String
contractComments

Notes:

This is a string attribute that contains a free-form textual field that can be used to add descriptive information to an existing contract.

public SequenceOf String
contractSearchCriteria

Notes:

This is an array of strings that are comma-delimited. It consists of attributes or keywords which can be used to locate and/or select this Contract.

public String
assumptions

Notes:

This is a free-form string attribute that contains any assumptions regarding the deployment or operation of this BusinessContract.

public Integer
contractResult

Notes:

This is an enumerated integer, and contains the status of the Contract as a whole (not of its individual methods). Values include: 0: Unknown 1: Executed successfully 2: Failed 3: Still running 4: Lost communications A status of 1 means that all requested obligations were met, and that all benefits were provided. It also means that no exceptions occurred. A status of 2 means that an exception occurred, and that one or more obligations were not met and/or one or more benefits were not provided. More detail is provided in the system view. A status of 3 means that the Contract is still executing. A status of 4 means that the management system that is monitoring the Contract can no longer communicate with the Contract.

Element	Source Role	Target Role	Details
BusinessContractSpec Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of BusinessContracts that are specified by this particular BusinessContractSpec. This enable the invariant attributes and relationships (and in other views, methods, constraints, and other model elements) to be specified once in the BusinessContractSpec class and then used in each specific BusinessContract. This ensures that each BusinessContract derived from the same BusinessContractSpec will have the same set of core features and behavior.<br/></p>
BusinessContractComposite Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of BusinessContracts that make up this particular BusinessContract.<br/></p>
BusinessContext Class	Name:	Name:
PartyRole Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the PartyRole that is responsible for defining this BusinessContract, including editing it. Note, however, that this does NOT mean that this PartyRole will manage this BusinessContract.<br/></p>
ManagementInfo Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>[From BusinessContract Fig. 14]<br/></p><p><br/></p><p>This association defines the set of ManagementInfo (e.g., FCAPS data) that will be obtained for this ManagedEntity. Note that ManagementInfo is obtained using the MgmtInfoObtainedBy association, and is linked to a ManagedEntity by the DescribedByMgmtInfo aggregation. Thus, this association defines which ManagementInfo needs to be obtained.<br/></p>
PolicyRule Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>[From BusinessContract Fig. 12]<br/></p><p><br/></p><p>This association defines the set of Policies that are used to govern the behavior of this BusinessContract.<br/></p>
Resource Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the set of functions, as specified by a BusinessContract, that apply to this particular Resource. Functions include defining how to build a Resource, how to manage it, how to operate it, how to invoke its functionality, and other related operations.<br/></p>
Service Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the set of functions, as specified by a BusinessContract, that apply to this particular Service. Functions include defining how to build a Service, how to manage it, how to operate it, how to invoke its functionality, and other related operations.<br/></p>
Product Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the set of functions, as specified by a BusinessContract, that apply to this particular Product. Note that this can serve to orchestrate sub-contracts that each control functionality for the Products, Resources and/or Services that make up this Product.<br/></p>

Element	Source Role	Target Role	Details
BusinessContractLimitations Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of business limitations that affect this particular BusinessContract.<br/></p>
CommonOAMBusinessConcepts Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the common OA&M Business Concepts used to obtain management information about a ManagedEntity, as implemented through a BusinessContract.<br/></p>
BusinessGoal Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the set of BusinessGoals that are realized by this BusinessContract.<br/></p>
BusinessCapabilities Class	Name:	Name:
BusinessProcess Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the set of BusinessProcesses that are used to implement the behavior specified in this BusinessContract.<br/></p>
BusinessBenefits Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of Benefits, from a business point-of-view, that will result from using this BusinessContract, providing that its obligations were first satisfied before it was used.<br/></p>
BusinessActivity Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the set of BusinessActivities that are conducted by this BusinessContract.<br/></p>
BusinessObligations Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of Obligations, from a business point-of-view, that must be satisfied before this BusinessContract can be used.<br/></p>
PartyRole Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the set of restricted functionality that this particular PartyRole has with respect to this BusinessContract.<br/></p>
Organization Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the particular Organization that is responsible for creating this BusinessContract.<br/></p>
BusinessInteraction Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of BusinessInteractions that are used by a particular BusinessContract.<br/></p>
Role Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the set of Stakeholders, represented by appropriate Roles, that limit the functionality or operation of this BusinessContract. <br/></p><p><br/></p><p>A Stakeholder might only be able to use this BusinessContract for a certain period. This is represented by implementing this association as an association class, which uses a PolicyConditionTimePeriod to represent the time period in which this BusinessContract can be offered.<br/></p>
ManagedEntity Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the set of BusinessContracts that are used to govern the behavior of a given ManagedEntity.<br/></p>
ManagementMethodEntity Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This association defines the set of ManagementMethodEntities (e.g., SNMP, CLI, etc.) that will be used to obtain different types of ManagementInfo (e.g., FCAPS data). Note that a ManagementMethodEntity obtains ManagementInfo using the MgmtInfoObtainedBy association. Thus, this association defines how to instantiate the MgmtInfoObtainedBy association.<br/></p>

Object	Type	Connection	Notes
BusinessContractLimitations	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of business limitations that affect this particular BusinessContract.
BusinessContractSpec	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of BusinessContracts that are specified by this particular BusinessContractSpec. This enable the invariant attributes and relationships (and in other views, methods, constraints, and other model elements) to be specified once in the BusinessContractSpec class and then used in each specific BusinessContract. This ensures that each BusinessContract derived from the same BusinessContractSpec will have the same set of core features and behavior.
BusinessContractComposite	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of BusinessContracts that make up this particular BusinessContract.
BusinessContractComposite	Class	Tree
BusinessContractAtomic	Class	Tree
CommonOAMBusinessConcepts	Class	Class	Copyright TM Forum 2005 This association defines the common OA&M Business Concepts used to obtain management information about a ManagedEntity, as implemented through a BusinessContract.
BusinessCapabilities	Class	Weak
BusinessBenefits	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of Benefits, from a business point-of-view, that will result from using this BusinessContract, providing that its obligations were first satisfied before it was used.
BusinessObligations	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of Obligations, from a business point-of-view, that must be satisfied before this BusinessContract can be used.
PartyRole	Class	Class	Copyright TM Forum 2005 This association defines the set of restricted functionality that this particular PartyRole has with respect to this BusinessContract.
BusinessInteraction	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of BusinessInteractions that are used by a particular BusinessContract.
Role	Class	Class	Copyright TM Forum 2005 This association defines the set of Stakeholders, represented by appropriate Roles, that limit the functionality or operation of this BusinessContract. A Stakeholder might only be able to use this BusinessContract for a certain period. This is represented by implementing this association as an association class, which uses a PolicyConditionTimePeriod to represent the time period in which this BusinessContract can be offered.
ManagementInfo	Class	Class	Copyright TM Forum 2005 [From BusinessContract Fig. 14] This association defines the set of ManagementInfo (e.g., FCAPS data) that will be obtained for this ManagedEntity. Note that ManagementInfo is obtained using the MgmtInfoObtainedBy association, and is linked to a ManagedEntity by the DescribedByMgmtInfo aggregation. Thus, this association defines which ManagementInfo needs to be obtained.
Agreement	Class	Generalization
ManagementMethodEntity	Class	Class	Copyright TM Forum 2005 This association defines the set of ManagementMethodEntities (e.g., SNMP, CLI, etc.) that will be used to obtain different types of ManagementInfo (e.g., FCAPS data). Note that a ManagementMethodEntity obtains ManagementInfo using the MgmtInfoObtainedBy association. Thus, this association defines how to instantiate the MgmtInfoObtainedBy association.
Resource	Class	Class	Copyright TM Forum 2005 This association defines the set of functions, as specified by a BusinessContract, that apply to this particular Resource. Functions include defining how to build a Resource, how to manage it, how to operate it, how to invoke its functionality, and other related operations.
Service	Class	Class	Copyright TM Forum 2005 This association defines the set of functions, as specified by a BusinessContract, that apply to this particular Service. Functions include defining how to build a Service, how to manage it, how to operate it, how to invoke its functionality, and other related operations.
Product	Class	Class	Copyright TM Forum 2005 This association defines the set of functions, as specified by a BusinessContract, that apply to this particular Product. Note that this can serve to orchestrate sub-contracts that each control functionality for the Products, Resources and/or Services that make up this Product.