...
Path - cps-persistence-spi-spi-docs\docs\dps-core-spi\com\ericsson\oss\itpf\datalayer\dps\object\spi
Name | Definition | Capabilities | |
---|---|---|---|
1 | Interface PersistenceLayerPersistenceObject | Exposes functionality only available on the persistence layer objects. |
Sets the new version of this persistence object.
Remove all associations of this persistence object. |
2 | Interface PersistenceLayerManagedObject | Exposes functionality only available on the persistence layer objects. |
Used to pre-load children from the database into memory. This method is provided to optimise use cases which will be doing multiple calls to |
3 | Class MinimalObjectData | Provides the basic information needed to access an object. |
Get the native database ID of the object.
Get the type of the object.
Get the version of the object.
|
4 | Interface DecoratedPersistenceObject | Extends the public persistence object interface with methods that are used internally by DPS but are not to be exposed externally to clients. |
Get the native database identity of the database object backing this persistence object. Use of this must be done with great care, as it will vary in its behaviour with respect to consistency, volatility, etc. depending on the database being used. It should never be exposed to applications and is for use within the DPS layer only.
Gets the data bucket name to which this persistence object belongs.
Gets the persistence layer object without any layers of decoration. If the innermost object is not a persistence layer object then a suitable exception will be thrown.
Gets the object being decorated by the layer of decoration specified.
Passes the attributes supplied by the user for a new persistence object so that they may be verified as required. This method will be invoked when creating a new persistence object but should not be used to set the attribute values, that is the purpose of The purpose of this method is to allow decorators perform actions on the specific attributes supplied by the user, as opposed to the final set of attributes to be applied on the new object, which may contain merged in default values. The implementation of this method may not modify the supplied attribute map as they are passed through the layers of decorators. And if the original map is required for later use it should be copied as it may get changed subsequently when
Initializes the attributes for a new persistence object. This method should be invoked when creating a new persistence object rather than using setAttributes() as it will have different behavior, namely:
The implementation of this method may modify the supplied attribute map as they are passed through the layers of decorators.
Removes backpointer from this persistence object to the persistence object which is referencing it by uni-directional with backpointer association.
Sets backpointer from this persistence object to the persistence object which is referencing it by uni-directional with backpointer association.
Retrieves referencing persistence objects for backpointer names for all uni-directional with backpointer associations referencing this persistence object.
Gets the values for the attributes which have been specifically set on this object. This includes attributes which:
Note that an attribute may have been specifically set to null so the values returned in the map may contain nulls.
Determines if the supplied attribute has been specifically set (includes attributes which were set to null).
Gets the primary type specification for this object.
Gets change identifier for this persistence object.
Gets all of the attribute names available in this persistence object.
Unsets the values of the supplied attributes. |
5 | Class BasicManagedObjectData | Used to efficiently transfer basic information about a Managed Object - without the full Managed Object and without the bloat of the existing Data Transfer Objects (DTOs). |
|
6 | Interface DecoratedManagedObject | Extends the public managed object interface with methods that are used internally by DPS but are not to be exposed externally to clients. |
Get the RDN of the managed object.
Returns the existing amount of the managed object of the type referenced by type namespace and name.
Sets the active choice case for the given choice.
Retrieves the active choice case for the given choice.
Retrieves all the children managed object of a given type. |
Object Exception
Path - cps-persistence-spi-spi-docs\docs\dps-core-spi\com\ericsson\oss\itpf\datalayer\dps\object\spi\exception
Name | Definition | Capabilities | |
---|---|---|---|
1 | Class AssociationAlreadyDefinedException | Exception thrown when the user tries to create an association that already exists. |
|
2 | Class ChildAlreadyDefinedException | Exception thrown when a new child object is attempted to be created under a parent which already has a child with that type and name. |
|
3 | Class GroupAlreadyDefinedException | An attempt was made to create a Group with non-unique namespace and name. |
|
4 | Class GroupNotAccessibleException | An exception thrown when the requested group is not accessible to current user. |
|
5 | Class GroupNotFoundException | An exception thrown when a group requested from DPS method does not exist. |
|