99 lines
9.3 KiB
ReStructuredText
99 lines
9.3 KiB
ReStructuredText
|
|
Property
|
|
--------
|
|
|
|
This is the base class for Properties
|
|
|
|
|
|
.. table:: **Property**
|
|
|
|
+------------------------------------------------------+------+------------+-------------+
|
|
| Name | Type | Attributes | Description |
|
|
+======================================================+======+============+=============+
|
|
| This type does not define any additional attributes. |
|
|
+------------------------------------------------------+------+------------+-------------+
|
|
|
|
|
|
The **Property** current version is 1.0.0.
|
|
|
|
Changelog:
|
|
|
|
* **1.0.0**: First Version.
|
|
|
|
|
|
PropagationConstraint
|
|
---------------------
|
|
|
|
This class provides propagation constraint for Relation
|
|
|
|
|
|
.. table:: **PropagationConstraint** ``extends`` **Property**
|
|
|
|
+--------+--------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Name | Type | Attributes | Description |
|
|
+========+========+=====================================================================================================+========================================================================================================================================================================================================================================================================================+
|
|
| remove | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` ``Regex:^(cascadeWhenOrphan|cascade|keep)$`` | It indicates the behaviour to implement for the target Entity when a 'remove' action is performed on the source Resource. Remove actions are: (i) the operation of removing an instance from a context; (ii) the operation of deleting an instance (it has an impact on all contexts). |
|
|
+--------+--------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| add | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` ``Regex:^(propagate|unpropagate)$`` | It indicates the behaviour to implement for the target Entity when an 'add' action is performed on the source Resource. Add action is the operation of adding an instance to a context. |
|
|
+--------+--------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
|
The **PropagationConstraint** current version is 1.0.0.
|
|
|
|
Changelog:
|
|
|
|
* **1.0.0**: First Version.
|
|
|
|
|
|
Encrypted
|
|
---------
|
|
|
|
This is the base class for Encrypted values
|
|
|
|
|
|
.. table:: **Encrypted** ``extends`` **Property**
|
|
|
|
+-------+--------+--------------------------------------------------------+-------------+
|
|
| Name | Type | Attributes | Description |
|
|
+=======+========+========================================================+=============+
|
|
| value | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | |
|
|
+-------+--------+--------------------------------------------------------+-------------+
|
|
|
|
|
|
The **Encrypted** current version is 1.0.0.
|
|
|
|
Changelog:
|
|
|
|
* **1.0.0**: First Version.
|
|
|
|
|
|
Header
|
|
------
|
|
|
|
This class provides metadata per every IdentifiableElement
|
|
|
|
|
|
.. table:: **Header** ``extends`` **Property**
|
|
|
|
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Name | Type | Attributes | Description |
|
|
+================+========+====================================================================================================================================================+=====================================================================================================================================================================================================+
|
|
| creationTime | Date | ``Mandatory:true`` ``ReadOnly:true`` ``NotNull:true`` | Creation time. It represents the difference, measured in milliseconds, between the creation time and midnight, January 1, 1970, UTC. |
|
|
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| lastUpdateTime | Date | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Last Update time. At creation time it assumes the same value of creationTime. It represents the difference, measured in milliseconds, between the creation time and midnight, January 1, 1970, UTC. |
|
|
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| createdBy | String | ``Mandatory:true`` ``ReadOnly:true`` ``NotNull:true`` | The user that created the Entity or the Relation. It is initialized at creation time. |
|
|
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| uuid | String | ``Mandatory:true`` ``ReadOnly:true`` ``NotNull:true`` ``Regex:^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}$`` | This UUID is be used to identify the Entity or the Relation univocally. |
|
|
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| lastUpdateBy | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The user that made the last update to the Entity or the Relation. At creation time, it assumes the same value of creator. |
|
|
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
|
The **Header** current version is 1.0.0.
|
|
|
|
Changelog:
|
|
|
|
* **1.0.0**: First Version.
|
|
|