Following is a draft proposal jointly developed with Jessie S Jewitt, with input from Andy Mayer and Arun Gupta .
This is related to a presentation found here.
There appears to be some issues with the gendoc tool, which generates the output from Papyrus, so you may notice some interesting things in the class tables that follow.
1.1 RootObjectClasses
1.1.1 Overview
Qualified Name: Common::Root::RootObjectClasses
1.1.1.1 Classes
1.1.1.1.1 DesignEntity class
Qualified Name: Common::Root::RootObjectClasses::DesignEntity
Description:
A template which describes an OperationalEntity in terms of deployment and operational behavior requirements.
This class is abstract.
Parent class: Entity
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 7‑1 Attributes for Class DesignEntity
| Attribute Name | Type | Mult. | Description | Stereotypes |
validFor | TimePeriod | 1 | The period during which the design entity is valid.
| OpenModelAttribute
|
status | String | 1 | The condition of the specification, such s active, inactive, or planned.
| OpenModelAttribute
|
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
name | String | 0..1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 0..1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|
1.1.1.1.2 Domain class
Qualified Name: Common::Root::RootObjectClasses::Domain
Description:
Defines a collection of entities that share a common purpose. In addition, each constituent Entity in an Domain is both uniquely addressable and uniquely identifiable within that Domain
Parent class: RootEntity
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 7‑2 Attributes for Class Domain
| Attribute Name | Type | Mult. | Description | Stereotypes |
name | String | 0..1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 0..1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|
1.1.1.1.3 Entity class
Qualified Name: Common::Root::RootObjectClasses::Entity
Description:
This is an abstract class that extends the RootEntity class and represents characteristics and behaviors of concepts that pertain to the NFV managed environment.
This class is abstract.
Parent class: RootEntity
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 7‑2 Attributes for Class Entity
| Attribute Name | Type | Mult. | Description | Stereotypes |
name | String | 0..1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 0..1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|
1.1.1.1.4 ManagedEntity class
Qualified Name: Common::Root::RootObjectClasses::ManagedEntity
Description:
A ManagedEntity is used to specify that an Entity is manageable by electronic means.
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 7‑1 Attributes for Class ManagedEntity
| Attribute Name | Type | Mult. | Description | Stereotypes |
managementMethodCurrent | Integer | 1 | This is an enumerated integer that defines the particular type of management method that is currently being used.
| OpenModelAttribute
|
managementMethodSupported | Integer | 1..* | This is an array of integers that define the different management methods that are supported by this object.
| OpenModelAttribute
|
1.1.1.1.5 OperationalEntity class
Qualified Name: Common::Root::RootObjectClasses::OperationalEntity
Description:
An OperationalEntity is a deployment in a NFV environment of a DesignEntity.
This class is abstract.
Parent class: Entity
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 7‑2 Attributes for Class OperationalEntity
| Attribute Name | Type | Mult. | Description | Stereotypes |
name | String | 0..1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 0..1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|
1.1.1.1.6 RootEntity class
Qualified Name: Common::Root::RootObjectClasses::RootEntity
Description:
This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment.
This class is abstract.
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
- Reference
- reference: TMF & MEF
Table 7‑1 Attributes for Class RootEntity
| Attribute Name | Type | Mult. | Description | Stereotypes |
name | String | 0..1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 0..1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|