diff options
Diffstat (limited to 'docs/ONAP Model Spec/im/Common')
| -rw-r--r-- | docs/ONAP Model Spec/im/Common/BusinessInteraction.png | bin | 0 -> 144917 bytes | |||
| -rw-r--r-- | docs/ONAP Model Spec/im/Common/BusinessInteraction.rst | 582 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/Common/DynamicParameters.png | bin | 0 -> 456495 bytes | |||
| -rw-r--r-- | docs/ONAP Model Spec/im/Common/DynamicParameters.rst | 492 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/Common/SelectionCriteria.png | bin | 0 -> 375760 bytes | |||
| -rw-r--r-- | docs/ONAP Model Spec/im/Common/SelectionCriteria.rst | 252 |
6 files changed, 1326 insertions, 0 deletions
diff --git a/docs/ONAP Model Spec/im/Common/BusinessInteraction.png b/docs/ONAP Model Spec/im/Common/BusinessInteraction.png Binary files differnew file mode 100644 index 0000000..08977ed --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/BusinessInteraction.png diff --git a/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst b/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst new file mode 100644 index 0000000..3f287a8 --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst @@ -0,0 +1,582 @@ +.. Copyright 2019 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Business Interaction Model +========================== + +.. contents:: + :depth: 3 +.. + +Diagram +------- + +Business Interaction +^^^^^^^^^^^^^^^^^^^^ + +.. image:: BusinessInteraction.png + +Class Definition +---------------- + +BusinessInteractionItemRelationship class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses:: BusinessInteractionItemRelationship + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for Class BusinessInteractionItemRelationship** + +================== ========== ========= ===================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ===================================================== ===================== +type String 1 The type of relationship such as contains, relies on. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +validFor TimePeriod 1 Time period for which the relationship is valid OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ===================================================== ===================== + +Agreement class +^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Agreement + +**Description:** + +A type of BusinessInteraction that represents a contract or arrangement, either written or verbal and sometimes enforceable by law. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class Agreement** + +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +documentNumber String 1 A reference number assigned to an Agreement that follows a prescribed numbering system. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +statementOfIntent String 1 An overview and goals of the Agreement. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +StartDate DateTime 1 Date interaction initiated OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +endDate DateTime 1 The date on which an interaction is closed or completed. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +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 + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute + + Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== + +BusinessInteraction class +^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteraction + +**Description:** + +A BusinessInteraction is an arrangement, contract, communication or joint activity between one or more PartyRoles, ResourceRoles, or CustomerAccounts. A BusinessInteraction may consist of one or more BusinessInteractionItems. A BusinessInteractionItem may refer to a Product, Service, Resource, or one of their specifications. A BusinessInteraction is further defined by one or more Places. One BusinessInteraction may reference another BusinessInteraction and one BusinessInteractionItem may reference another BusinessInteractionItem on the same or different BusinessInteraction. Types of BusinessInteractions include : Requests, Responses, Notifications, and Agreements. + +This class is abstract. + +**Parent class:** RootEntity + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class BusinessInteraction** + +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +StartDate DateTime 1 Date interaction initiated OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +endDate DateTime 1 The date on which an interaction is closed or completed. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +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 + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute + + Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== + +BusinessInteractionItem class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionItem + +**Description:** + +The purpose for the BusinessInteraction expressed in terms of a ProductSpecification, ProductOffering, ServiceSpecification or ResourceSpecification or may refer to a Product, Service, or Resource. + +This class is abstract. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class BusinessInteractionItem** + +================== ======== ========= ======================================================================= ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= ======================================================================= ===================== +quantity Integer 1 Quantity of an interaction item involved in an interaction. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +action String 1 The action to take for an InteractionItem, such as add, change, remove. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ======== ========= ======================================================================= ===================== + +BusinessInteractionRelationship class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionRelationship + +**Description:** + +An association between two Interactions. For example, a Notification sent to customers affected by a problem contained on a Trouble Report; a response to a request, an agreement and the interactions that led up to the agreement. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class BusinessInteractionRelationship** + +================== ========== ========= =============================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= =============================================================================== ===================== +type String 1 A categorization of the relationship, such as bulk, parent/child, and so forth. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +validFor TimePeriod 1 Time period for which the relationship is valid OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= =============================================================================== ===================== + +BusinessInteractionSpec class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionSpec + +**Description:** + +The invariant characteristics (attributes in the business view, and methods, constraints, relationships, and behavior in the system view) and behavior of a BusinessInteraction. This is done by optionally defining a set of BusinessInteractionSpecItems, each of which aggregates one or more other types of Specifications. This helps to ensure that different BusinessInteractions have the same basic characteristics and behavior by deriving them from the same BusinessInteractionSpec. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +BusinessInteractionVersion class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionVersion + +**Description:** + +Version of the business interaction. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +Notification class +^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Notification + +**Description:** + +A communication that informs about something that has or will happen. A Notification is typically one-sided, in that no Response is expected. A Notification can be created as the result of a Request; for example, a Trouble Report may result in Notifications being sent to affected Parties. A Notification is a type of Business Interaction. + +This class is abstract. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From the TMF SID + +Request class +^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Request + +**Description:** + +The act of asking that something be done that typically involves a Response. Request is a type of Business Interaction. + +This class is abstract. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From the TMF SID + +Response class +^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Response + +**Description:** + +A reply to a Request + +This class is abstract. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From the TMF SID diff --git a/docs/ONAP Model Spec/im/Common/DynamicParameters.png b/docs/ONAP Model Spec/im/Common/DynamicParameters.png Binary files differnew file mode 100644 index 0000000..b7d41f8 --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/DynamicParameters.png diff --git a/docs/ONAP Model Spec/im/Common/DynamicParameters.rst b/docs/ONAP Model Spec/im/Common/DynamicParameters.rst new file mode 100644 index 0000000..17d1a7e --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/DynamicParameters.rst @@ -0,0 +1,492 @@ +.. Copyright 2020 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Dynamic Parameters Model +======================== + +Diagrams +-------- + +.. image:: DynamicParameters.png + +Dynamic Parameters +~~~~~~~~~~~~~~~~~~~ + +Classes +------- + +DiscreteValueSpec +~~~~~~~~~~~~~~~~~ + +DiscreteValueSpec represents a specific valid value that a given Parameter can take on. + +**Parent class:** ParmSpecValue + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ======== ========= ================================== ================================================ +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +value String 1 Preliminary A discrete value that the Parameter can take on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================================ + +Parameter +~~~~~~~~~ + +Some parameter that is part of a ParameterGroup. If parameter can only hold certain values, those values are specified via ParameterSpecValue (design time). The actual value is specified via ParameterValue (runtime). + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ============== ========= ================================== ================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +parameterName String 1 Preliminary Name of parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +IsInput Boolean 1 Preliminary Boolean that specifices if this parameter is an input parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +paramvalue ParameterValue 0..\* OpenModelAttribute Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +isModifiable Boolean 1 Preliminary Bolean that specifices if the value can be modified or changed during the life of this parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueType String 1 Preliminary The type of this parameter (integer, string, ...). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +unitOfMeasure String 0..1 Preliminary A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 1 Preliminary Description of the parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ============== ========= ================================== ================================================================================================================================================================================================================================================================================================================== + +ParameterGroup +~~~~~~~~~~~~~~ + +A group of parameters that somehow relate or work together. + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +========================= ========== ========= ================================== ============================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +parameterGroupName String 1 Preliminary Name of ParameterGroup + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +parameterGroupDescription String 1 Preliminary Description of ParameterGroup. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +parameterGroupId Identifier 1 Preliminary ID of ParameterGroup. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================= ========== ========= ================================== ============================== + +ParameterValue +~~~~~~~~~~~~~~ + +The actual value of Parameter (runtime). + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ========= ========= ================================== =========================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +parameter Parameter 1 OpenModelAttribute Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +value String 1 Preliminary The actual value of Parameter (runtime). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ========= ========= ================================== =========================================================================================================================== + +ParmSpecValue +~~~~~~~~~~~~~ + +A valid value of parameter (design time). Values can be either a range (RangeValueSpec) or discrete (DiscreteValueSpec). + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +RangeValueSpec +~~~~~~~~~~~~~~ + +RangeValueSpec is generally expected to be of valueType integer or + +RangeValueSpec generally should have a valueType of either integer or real. valueFrom, valueTo, and rangeStep should all be of the same valuetype for some Parameter. + +rangeStep should be greater than zero. + +valueTo should be greater than valueFrom + +**Parent class:** ParmSpecValue + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ======== ========= ================================== ============================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +valueMin String 1 Preliminary The minimum value that a Parameter can take on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueMax String 1 Preliminary The maximum value that the parameter can take on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +rangeStep String 0..1 Preliminary The specification that a range of values increases in steps, such as a range from 0 to 100 in steps of 5 with the resulting permitted values being 0, 5, 10, 15,...100. This complements the valueFrom and valueTo attributes. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ============================================================================================================================================================================================================================== + +Associations +------------ + +ParameterGroupHasParameter +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A Parameter can be in more than one ParameterGroup, and a ParameterGroup can have some number of Parameters. + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +parameter shared Not navig. 1..\* Parameter OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +dynamicparameter none Not navig. 0..\* ParameterGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== =============== ===================== + +ParameterHasInstanceValue +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== ================================================================================================================================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +paramvalue composite Navig. 0..\* ParameterValue Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...). OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +parameter none Navig. 1 Parameter Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== ================================================================================================================================================================== ===================== + +OperationalEntityFurtherDefinedByParam +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ================= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +dynamicparamvalue none Not navig. 0..\* ParameterValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +operationalentity none Not navig. 1 OperationalEntity OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ================= =============== ===================== + +DesignEntityFurtherDefinedByParmGroup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +dynamicparameter none Not navig. 0..\* ParameterGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +designentity none Not navig. 0..\* DesignEntity OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== =============== ===================== + +ParmSpecValueIntantiatedAsDynamicParmValue +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_parametervalue none Not navig. 0..\* ParameterValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +parmspecvalueii none Not navig. 0..1 ParmSpecValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== =============== ===================== + +ParameterEnumeratedBy SpecValue +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +parameter none Not navig. 1 Parameter OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +parmspecvalueii composite Not navig. 0..\* ParmSpecValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============= =============== ===================== diff --git a/docs/ONAP Model Spec/im/Common/SelectionCriteria.png b/docs/ONAP Model Spec/im/Common/SelectionCriteria.png Binary files differnew file mode 100644 index 0000000..70d709a --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/SelectionCriteria.png diff --git a/docs/ONAP Model Spec/im/Common/SelectionCriteria.rst b/docs/ONAP Model Spec/im/Common/SelectionCriteria.rst new file mode 100644 index 0000000..5452faa --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/SelectionCriteria.rst @@ -0,0 +1,252 @@ +.. Copyright 2020 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Selection Criteria Model +======================== + +Diagrams +-------- + +SelectionCriteria +~~~~~~~~~~~~~~~~~~ + +.. image:: SelectionCriteria.png + +Classes +------- + +.. _selectioncriteria-1: + +SelectionCriteria +~~~~~~~~~~~~~~~~~ + +SelectionCriteria finds descriptors and instances according to specific properties of those entities. + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ========== ========= ================================== ============================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +SelectionCriteriaId Identifier 1 Preliminary Unique indentifier of this SelectionCriteria. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ========== ========= ================================== ============================================= + +SelectionCriteriaAtomic +~~~~~~~~~~~~~~~~~~~~~~~ + +A simple (atomic) selection criteria that holds a specific attribute comparision expression. + +**Parent class:** SelectionCriteria + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ========== ========= ================================== ================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +metricName String 1 Preliminary Name of compared parameter or attribute. + + OpenModelAttribute Name of compared parameter or attribute. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +operator Operator 1 Preliminary Comparison operator, e.g. equal, less than, greater or etc. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +value String 1 Preliminary Compared value (can be a name of a parameter in referenced class). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueType String 1 Preliminary The type of the value property (String, Integer, Real, ...). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SelectionCriteriaId Identifier 1 Preliminary Unique indentifier of this SelectionCriteria. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ========== ========= ================================== ================================================================== + +SelectionCriteriaComposite +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A SelectionCriteria that is an aggregation of multiple selection criterias. Agregation can be for example AND, OR, or XOR logical operations. + +**Parent class:** SelectionCriteria + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ================= ========= ================================== ===================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +compositeOperator CompositeOperator 1 Preliminary Logical operation for filters composition, e.g. logical AND, OR, XOR. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SelectionCriteriaId Identifier 1 Preliminary Unique indentifier of this SelectionCriteria. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ================= ========= ================================== ===================================================================== + +Associations +------------ + +DesignEntityHasSelectionCriteria +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ================= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +designentity none Not navig. 0..\* DesignEntity OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +selectioncriteria none Not navig. 0..\* SelectionCriteria OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ================= =============== ===================== + +SelectionCriteriaCompositeComprisedOfSelectionCriteria +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +========================== =========== ========== ========= ========================== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +selectioncriteria shared Not navig. 2..\* SelectionCriteria OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +selectioncriteriacomposite none Not navig. 0..\* SelectionCriteriaComposite OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================== =========== ========== ========= ========================== =============== ===================== + +Enumerations +------------ + +CompositeOperator +~~~~~~~~~~~~~~~~~ + +The operator being applied to to some group of selectoin critiera. + +Contains Enumeration Literals: + +- AND: + +- OR: + +- XOR: + +Operator +~~~~~~~~ + +The operator being applied to some atomic selection critera. + +Contains Enumeration Literals: + +- MORETHAN: + +- LESSTHAN: + +- EQUAL: |
