Following is some initial draft material on some abstract root entities. Definitions will follow shortly.concepts.
Diagrams
Figure 1 - RootEntity
Figure 2 - Descriptor (basis for all design time classes)
...
Figure 3 - Onboarding and Platform Class Interrelationships
Classes
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.
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Attributes for Class RootEntity
| Attribute Name | Type | Mult. | Description | Stereotypes |
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
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
|
Descriptor (EntitySpecification) class
Qualified Name: Common::Root::RootObjectClasses::Descriptor (EntitySpecification)
Description:
This is an abstract base class that is used to define the common characteristics (attributes, constraints, and relationships) of a design time entity.
Parent class: RootEntity
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Attributes for Class Descriptor (EntitySpecification)
| Attribute Name | Type | Mult. | Description | Stereotypes |
validFor | TimePeriod | 1 | The period during which the descriptor is valid.
| OpenModelAttribute
|
status | String | 1 | The condition of the specification, such s active, inactive, or planned.
| OpenModelAttribute
|
descriptorVersion | String | 1 | Identifies the version of the descriptor.
| 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
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
|
Entity class
Qualified Name: Common::Root::RootObjectClasses::Entity
Description:
This is an abstract class that extends the RootEntity class in order to represent classes of objects that represent runtime instances (VnfInstance, ServiceInstance,etc).
Parent class: RootEntity
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Attributes for Class Entity
| Attribute Name | Type | Mult. | Description | Stereotypes |
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
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
|