Skip navigation links

oracle.iam.rm.temporal.model
Interface ObjectType

All Known Subinterfaces:

MixinObjectType, StructuralObjectType

public interface ObjectType

Definition of an object type within the data model.

Method Summary

AttributeDefinition	getAttributeDefinition(java.lang.String attributeKey) Gets an AttributeDefinition for this object type by attribute key.
AttributeDefinition[]	getAttributeDefinitions() Gets all of the AttributeDefinitions for this object type.
ObjectType	getExtendedObjectType() Gets the ObjectType from which this ObjectType extends.
java.lang.String	getKey() Gets the key or ID of this ObjectType.
java.util.Set<java.lang.String>	getPermissions() Gets the permission identifiers that this object has declared.
SOCPolicy	getPermissionSocPolicy(java.lang.String permission) Gets the Sphere of Control policy to be used when determining whether instances of this object are within the Sphere of Control of a user's privileges for the specified permission.
java.lang.String	getReadAuditDetailsPermission() Gets the identifier of the permission necessary to read audit details for object instances of this type.
java.lang.String	getReadPermission() Gets the identifier of the permission necessary to read object instances of this type.
oracle.iam.rm.temporal.impl.RelatedAuditObject[]	getRelatedAuditObjects() Gets the RelatedAuditObjects for objects of this type.
RelationshipPathDefinition	getRelationshipPathDefinition(java.lang.String relationshipPathKey) Gets a RelationshipPathDefinition for this object type by relationship path key.
RelationshipPathDefinition[]	getRelationshipPathDefinitions() Gets all of the RelationshipPathDefinitions for this object type.
oracle.iam.rm.i18n.Formattable	getTitle() Gets the localized title for the object type.
java.lang.String	getTitleAttribute() Gets the attribute to use for the "title" of an object instance of this type.
boolean	instanceOf(java.lang.String objectTypeId) Determines whether this object type is an instance (either directly or as a subtype) of the object type provided.
boolean	isAbstractType() Determines whether this is an abstract type.
oracle.iam.rm.i18n.Formattable	validateCreate(SnapshotSession snapshotSession, java.util.Map<java.lang.String,ObjectKey> primaryKeys, java.util.Map<java.lang.String,? extends java.lang.Object> attributes) Runs object-scope validation for creating an object of this type with particular attributes.
oracle.iam.rm.i18n.Formattable	validateUpdate(SnapshotSession snapshotSession, SnapshotObject object, java.util.Map<java.lang.String,? extends java.lang.Object> attributeValues) Runs object-scope validation for updating a specific object of this type with particular attributes.

Method Detail

getKey

java.lang.String getKey()

Gets the key or ID of this ObjectType.

Returns:

String representing the identifier of this object type.

isAbstractType

boolean isAbstractType()

Determines whether this is an abstract type. If an object type is abstract, then an instance of this object type cannot be created without creating a non-abstract subtype.

Returns:

true if the object type is abstract, false otherwise

getAttributeDefinitions

AttributeDefinition[] getAttributeDefinitions()

Gets all of the AttributeDefinitions for this object type.

Returns:

all of the AttributeDefinitions for this object type.

getAttributeDefinition

AttributeDefinition getAttributeDefinition(java.lang.String attributeKey)

Gets an AttributeDefinition for this object type by attribute key.

Parameters:

attributeKey - the identifer of the attribute to retrieve

Returns:

an AttributeDefinition for this object type by attribute key or null if that attribute does not exist on this object type.

getRelationshipPathDefinitions

RelationshipPathDefinition[] getRelationshipPathDefinitions()

Gets all of the RelationshipPathDefinitions for this object type.

Returns:

all of the RelationshipPathDefinitions for this object type.

getRelationshipPathDefinition

RelationshipPathDefinition getRelationshipPathDefinition(java.lang.String relationshipPathKey)

Gets a RelationshipPathDefinition for this object type by relationship path key.

Parameters:

relationshipPathKey - the identifer of the relationship path to retrieve

Returns:

a RelationshipPathDefinition for this object type by relationship path key or null if that relationship path does not exist on this object type.

getTitle

oracle.iam.rm.i18n.Formattable getTitle()

Gets the localized title for the object type.

Returns:

the localized title for the object type.

instanceOf

boolean instanceOf(java.lang.String objectTypeId)

Determines whether this object type is an instance (either directly or as a subtype) of the object type provided.

Parameters:

objectTypeId - the identifier of the object type to compare to

Returns:

true if this object type or one of its supertypes is the object type specified, false otehrwise

getExtendedObjectType

ObjectType getExtendedObjectType()

Gets the ObjectType from which this ObjectType extends.

Returns:

The extended ObjectType for this object type or null if it does this object type is not a subtype.

getTitleAttribute

java.lang.String getTitleAttribute()

Gets the attribute to use for the "title" of an object instance of this type.

Returns:

the attribute to use for the "title" of an object instance of this type or null if one is not specified.

getReadPermission

java.lang.String getReadPermission()

Gets the identifier of the permission necessary to read object instances of this type.

Returns:

the identifier of the permission necessary to read object instances of this type or null if instances of this object type are readable by all users.

getReadAuditDetailsPermission

java.lang.String getReadAuditDetailsPermission()

Gets the identifier of the permission necessary to read audit details for object instances of this type.

Returns:

the identifier of the permission necessary to read audit details for object instances of this type or null if audit details for instances of this object type are readable by all users.

getPermissions

java.util.Set<java.lang.String> getPermissions()

Gets the permission identifiers that this object has declared.

Returns:

the permission identifiers that this object has declared.

getPermissionSocPolicy

SOCPolicy getPermissionSocPolicy(java.lang.String permission)

Gets the Sphere of Control policy to be used when determining whether instances of this object are within the Sphere of Control of a user's privileges for the specified permission.

Parameters:

permission - the identifier of the permission to get the Sphere of Control policy for

Returns:

the Sphere of Control policy for the specified permission or null is one is not configured

getRelatedAuditObjects

oracle.iam.rm.temporal.impl.RelatedAuditObject[] getRelatedAuditObjects()

Gets the RelatedAuditObjects for objects of this type.

Returns:

the RelatedAuditObjects for objects of this type.

validateUpdate

oracle.iam.rm.i18n.Formattable validateUpdate(SnapshotSession snapshotSession,
                                              SnapshotObject object,
                                              java.util.Map<java.lang.String,? extends java.lang.Object> attributeValues)

Runs object-scope validation for updating a specific object of this type with particular attributes.

Parameters:

snapshotSession - the session associated with this proposed change

object - the object to be changed

attributeValues - the attributes to set on the object being updated

Returns:

a Formattable of the error message if the validation fails or null if the validation succeeds

validateCreate

oracle.iam.rm.i18n.Formattable validateCreate(SnapshotSession snapshotSession,
                                              java.util.Map<java.lang.String,ObjectKey> primaryKeys,
                                              java.util.Map<java.lang.String,? extends java.lang.Object> attributes)

Runs object-scope validation for creating an object of this type with particular attributes.

Parameters:

snapshotSession - the session associated with this proposed change

primaryKeys - the primary keys to set on the object being created

attributes - the attributes to set on the object being created

Returns:

a Formattable of the error message if the validation fails or null if the validation succeeds

Skip navigation links