Skip navigation links

oracle.iam.rm.server_api.model
Interface ObjectType

All Superinterfaces:

java.io.Serializable

public interface ObjectType

extends java.io.Serializable

A definition of an object type that is defined by the server. This provides the basic information about an object's general information, attributes and relationship paths, allowing a client to handle the object "inteligently" based on the data model.

Method Summary

ServerAttributeDefinition	getAttributeDefinition(java.lang.String attributeName) Gets the definition of attribute that this object has by ID.
java.lang.String	getId() Gets the identifier of the object type.
EntityOperationMapping	getOperation(java.lang.String operationId) Gets an operation that this object has by ID.
ServerRelationshipPathDefinition	getRelationshipPathDefinition(java.lang.String relationshipPathName) Gets a relationship path that this object has by ID.
ServerRelationshipPathDefinition[]	getRelationshipPathDefinitions() Gets all relationship paths that this object has.
ServerAttributeDefinition[]	getServerAttributeDefinitions() Gets all attributes that this object has.
java.lang.String	getTitle() Gets the title of the object type.
java.lang.String	getTitleAttribute() Gets the attribute that should be used for the title of objects of this type.

Method Detail

getId

java.lang.String getId()

Gets the identifier of the object type.

Returns:

String representing the identifier of the object type.

getTitle

java.lang.String getTitle()

Gets the title of the object type.

Returns:

String representing the title of the object type.

getAttributeDefinition

ServerAttributeDefinition getAttributeDefinition(java.lang.String attributeName)

Gets the definition of attribute that this object has by ID.

Parameters:

attributeName - ID of the attribute

Returns:

The server attribute definition of the provided ID.

Throws:

java.lang.IllegalArgumentException - if an attribute of that ID does not exist on this object.

getServerAttributeDefinitions

ServerAttributeDefinition[] getServerAttributeDefinitions()

Gets all attributes that this object has.

Returns:

all attributes that this object has.

getRelationshipPathDefinition

ServerRelationshipPathDefinition getRelationshipPathDefinition(java.lang.String relationshipPathName)

Gets a relationship path that this object has by ID.

Parameters:

relationshipPathName - ID of the relationship path

Returns:

ServerRelationshipPathDefinition of the provided ID.

Throws:

java.lang.IllegalArgumentException - if a relationship path of that ID does not exist on this object.

getRelationshipPathDefinitions

ServerRelationshipPathDefinition[] getRelationshipPathDefinitions()

Gets all relationship paths that this object has.

Returns:

ServerRelationshipPathDefinition array of relationship paths that this object has.

getOperation

EntityOperationMapping getOperation(java.lang.String operationId)

Gets an operation that this object has by ID.

Parameters:

operationId - the ID of the operation.

Returns:

EntityOperationMapping of the provided ID.

Throws:

java.lang.IllegalArgumentException - if an operation of that ID does not exist on this object.

getTitleAttribute

java.lang.String getTitleAttribute()

Gets the attribute that should be used for the title of objects of this type.

Returns:

String representing the attribute that should be used for the title of objects of this type or null if it does not have a configured attribute-based title.

Skip navigation links