Skip navigation links

oracle.iam.rm.temporal
Interface SnapshotObject

All Known Subinterfaces:

Approver, AuditEvent, AuditEventDetail, BusinessRole, HierarchyNode, ITPrivilege, ITRole, ITRolePrivilegeMapping, Permission, PermissionAssociation, Person, Privilege, Resource, ResourceType, Role, RoleGrant, RoleMapping, SysRolePrivilegeMapping, SystemIdentity, SystemRole, User, UserRoleAssignment

public interface SnapshotObject

An object representing the vales of a TemporalObject at a particular point in value and transaction time.

Method Summary

void	delete() Makes the object ineffective.
void	delete(boolean cascade) Makes the object ineffective.
java.util.Map<java.lang.String,java.lang.Object>	getAllAttributes() Gets all of the attributes for this object.
java.lang.Object	getAttributeValue(java.lang.String attributeKey) Gets the value of an attribute.
oracle.iam.rm.i18n.Formattable	getDefaultTitle() Gets the value that should be used for the default title of this object.
SnapshotObject	getMixin(java.lang.String mixinType) Gets the SnapshotObject that represents the mix-in type.
ObjectKey	getObjectKey() Gets the pantemporal object identifier for this object.
ObjectType	getObjectType() Gets the ObjectType that defines this object.
SnapshotObject[]	getRelativeObjects(java.lang.String relationshipPath) Gets the snapshot version of a relative object.
SnapshotObject[]	getRelativeObjects(java.lang.String relationshipPath, Filter additionalFilter) Gets the snapshot version of a relative object.
SnapshotObject	getStructuralObject() Gets the structural SnapshotObject that a mix-in is bound to
ObjectType	getStructuralObjectType() Gets the object type of the structural SnapshotObject that a mix-in is bound to.
long	getVersion() Gets the current version of the object.
boolean	isEditable() Determines if the object is editable.
void	makeReadConsistent() Marks this object to act in a "read consistent" fashion so that if it is changed in another transaction an appropriate constraint violation is thrown.
AttributeChangeSet	setAttributeValue(java.lang.String attributeKey, java.lang.Object value) Sets an attribute value to be effective as of the snapshot time.
AttributeChangeSet	setAttributeValues(java.util.Map<java.lang.String,java.lang.Object> attributeValues) Sets a collection of attribute values to be effective as of the snapshot time.
boolean	stateEquals(SnapshotObject snapshotObject) Determines if another SnapshotObject's state is equal.
void	updateVersion(SnapshotObject snapshotObject) Updates the version of this object based on its equivalent from the system (read-only) session.

Method Detail

getAttributeValue

java.lang.Object getAttributeValue(java.lang.String attributeKey)
                                   throws TemporalException

Gets the value of an attribute.

Parameters:

attributeKey - identifier for the attribute

Returns:

Object the value of the attribute

Throws:

TemporalException - if a failure occurs retrieving the attribute value

getRelativeObjects

SnapshotObject[] getRelativeObjects(java.lang.String relationshipPath)

Gets the snapshot version of a relative object.

Parameters:

relationshipPath - identifier for the relative object

Returns:

Snapshot object array representing relative objects

getRelativeObjects

SnapshotObject[] getRelativeObjects(java.lang.String relationshipPath,
                                    Filter additionalFilter)

Gets the snapshot version of a relative object.

Parameters:

relationshipPath - identifier for the relative object

additionalFilter - additional filter to restrict the returned objects

Returns:

Snapshot object array representing relative objects

getObjectKey

ObjectKey getObjectKey()

Gets the pantemporal object identifier for this object.

Returns:

ObjectKey

getObjectType

ObjectType getObjectType()

Gets the ObjectType that defines this object.

Returns:

ObjectType

setAttributeValues

AttributeChangeSet setAttributeValues(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
                                      throws TemporalException

Sets a collection of attribute values to be effective as of the snapshot time.

Parameters:

attributeValues - names/values to set

Returns:

Attribute change set representing the operation

Throws:

TemporalException - if the object is not editable

setAttributeValue

AttributeChangeSet setAttributeValue(java.lang.String attributeKey,
                                     java.lang.Object value)
                                     throws TemporalException

Sets an attribute value to be effective as of the snapshot time.

Parameters:

attributeKey - the identifier for the attribute

value - the attribute value to set

Returns:

Attribute change set representing the operation

Throws:

TemporalException - if the object is not editable

stateEquals

boolean stateEquals(SnapshotObject snapshotObject)
                    throws TemporalException

Determines if another SnapshotObject's state is equal.

Parameters:

snapshotObject - SnapshotObject to compare this SnapshotObject to

Returns:

Boolean true if their snapshot states are equal, otherwise false

Throws:

TemporalException - if a failure occurs during object comparison

getAllAttributes

java.util.Map<java.lang.String,java.lang.Object> getAllAttributes()

Gets all of the attributes for this object.

Returns:

all of the attributes for this object.

getDefaultTitle

oracle.iam.rm.i18n.Formattable getDefaultTitle()
                                               throws TemporalException

Gets the value that should be used for the default title of this object.

Returns:

Formattable representing defalt title

Throws:

TemporalException - if a failure occurs during title retrieval

getMixin

SnapshotObject getMixin(java.lang.String mixinType)
                        throws TemporalException

Gets the SnapshotObject that represents the mix-in type.

Parameters:

mixinType - type of mixin

Returns:

SnapshotObject representing the mixin or null if this object does not have that mix-in

Throws:

TemporalException - if a failure occurs retrieving the related mixin

getStructuralObject

SnapshotObject getStructuralObject()

Gets the structural SnapshotObject that a mix-in is bound to

Returns:

Structural SnapshotObject that this mix-in is bound to or itself if it is a structural SnapshotObject

getStructuralObjectType

ObjectType getStructuralObjectType()

Gets the object type of the structural SnapshotObject that a mix-in is bound to.

Returns:

Object type of the structural SnapshotObject that a mix-in is bound to or of itself if it is a structural SnapshotObject.

delete

void delete()
            throws TemporalException

Makes the object ineffective.

Throws:

TemporalException - if this object is not editable or deletion fails

delete

void delete(boolean cascade)
            throws TemporalException

Makes the object ineffective. Forces a cascade action if

Parameters:

cascade - Boolean true forces a cascade delete, false only deletes the current object.

Throws:

TemporalException - if this object is not editable or deletion fails

isEditable

boolean isEditable()

Determines if the object is editable.

Returns:

Boolean true if editable, otherwise false

updateVersion

void updateVersion(SnapshotObject snapshotObject)

Updates the version of this object based on its equivalent from the system (read-only) session.

Parameters:

snapshotObject - version of this object from the system (read-only) session

Throws:

java.lang.IllegalStateException - if the object is not editable and not within a merge handler

java.lang.IllegalArgumentException - if the snapshot object provided is not the same as the current object or not from a system (read-only) session

makeReadConsistent

void makeReadConsistent()

Marks this object to act in a "read consistent" fashion so that if it is changed in another transaction an appropriate constraint violation is thrown.

Throws:

TemporalException - if this object is not editable or marking it "read consistent" fails

getVersion

long getVersion()

Gets the current version of the object.

Returns:

The current version of this object.

Skip navigation links