Skip navigation links

oracle.iam.rm.client
Interface Entity

public interface Entity

Interface for a generified object.

Method Summary

java.util.List<HierarchyNode>	getAllHierarchyNodes() Gets all of the HierarchyNode objects that are associated with this Entity.
EntityAttribute	getAttribute(java.lang.String attributeName) Gets an EntityAttribute for the provided attribute name.
AuditSummary	getAuditSummary() Gets the AuditSummary for this Entity.
ChangeSummary	getChangeSummary(java.lang.String attributeName) Gets the ChangeSummary for this Entity's attribute.
EntityKey	getEntityKey() Gets the EntityKey identifier for this Entity.
HierarchyNode	getHierarchyNode(java.lang.String hierarchyType) Gets the HierarchyNode for this Entity if it is in a hierarchy, otherwise returns null.
Entity	getMixin(java.lang.String mixinType) Gets an Entity that represents a mix-in attached to this Entity.
ObjectType	getObjectType() Gets the ObjectType of this Entity.
BusinessTransactionOperation	getOperation(java.lang.String operationId) Gets the business operation that is "bound" to this object type by its name.
java.util.Set<java.lang.String>	getReadableAttributeNames() Gets a Set of Strings representing attribute names that the current user has permission to read.
java.util.List<Entity>	getRelatedObjects(java.lang.String relationshipPath) Gets all of the related objects based on the specified relationship path.
Entity	getStructuralEntity(long transactionId) Either gets the Entity that this object is "attached to" if this object is a mix-in, otherwise it returns itself.
java.lang.String	getTitle() Gets the human-readable title for this Entity.
boolean	isMixin() Determines whether this Entity is a mix-in.

Method Detail

getTitle

java.lang.String getTitle()

Gets the human-readable title for this Entity.

Returns:

the human-readable title for this Entity or null if it is not set or the object type does not support an attribute-driven title.

getAttribute

EntityAttribute getAttribute(java.lang.String attributeName)

Gets an EntityAttribute for the provided attribute name.

Parameters:

attributeName - identifier of the attribute

Returns:

EntityAttribute for the attribute name.

Throws:

java.lang.IllegalArgumentException - if the attribute is not valid for this object.

getReadableAttributeNames

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

Gets a Set of Strings representing attribute names that the current user has permission to read.

Returns:

Set of attribute names that the current user has permission to read.

getOperation

BusinessTransactionOperation getOperation(java.lang.String operationId)

Gets the business operation that is "bound" to this object type by its name.

Parameters:

operationId - identifier of the business operation

Returns:

BusinessTransactionOperation that is "bound" to this object type by its name.

getEntityKey

EntityKey getEntityKey()

Gets the EntityKey identifier for this Entity.

Returns:

EntityKey identifier for this Entity.

getObjectType

ObjectType getObjectType()

Gets the ObjectType of this Entity.

Returns:

ObjectType of this Entity.

getAuditSummary

AuditSummary getAuditSummary()
                             throws ServerException

Gets the AuditSummary for this Entity.

Returns:

AuditSummary for this Entity.

Throws:

ServerException - if there is a failure retrieving the AuditSummary.

getChangeSummary

ChangeSummary getChangeSummary(java.lang.String attributeName)
                               throws ServerException

Gets the ChangeSummary for this Entity's attribute.

Parameters:

attributeName - identifier of the attribute

Returns:

ChangeSummary for this Entity's attribute.

Throws:

ServerException - if there is a failure retrieving the AuditSummary.

getHierarchyNode

HierarchyNode getHierarchyNode(java.lang.String hierarchyType)
                               throws ServerException

Gets the HierarchyNode for this Entity if it is in a hierarchy, otherwise returns null.

Parameters:

hierarchyType - String representing the identifier of the hierarchy

Returns:

HierarchyNode for this Entity if it is in a hierarchy or null if it is not.

Throws:

ServerException - if there is a failure retrieving the HierarchyNode.

getMixin

Entity getMixin(java.lang.String mixinType)
                throws ServerException

Gets an Entity that represents a mix-in attached to this Entity.

Parameters:

mixinType - identifier of the mix-in type

Returns:

Entity that represents a mix-in attached to this Entity or null if there is no mix-in.

Throws:

ServerException - if there is a failure retrieving the mix-in Entity.

getAllHierarchyNodes

java.util.List<HierarchyNode> getAllHierarchyNodes()
                                                   throws ServerException

Gets all of the HierarchyNode objects that are associated with this Entity.

Returns:

All HierarchyNode objects associated with this Entity.

Throws:

ServerException - if there is a failure retrieving mix-in Entity objects.

getRelatedObjects

java.util.List<Entity> getRelatedObjects(java.lang.String relationshipPath)
                                         throws ServerException

Gets all of the related objects based on the specified relationship path.

Parameters:

relationshipPath - identifier for the relationship path to traverse

Returns:

All objects at the far end of the specified relationship path

Throws:

ServerException - if there is a failure traversing the relationship path.

isMixin

boolean isMixin()

Determines whether this Entity is a mix-in.

Returns:

Boolean true if this Entity is a mix-in, otherwise false.

getStructuralEntity

Entity getStructuralEntity(long transactionId)
                           throws ServerException

Either gets the Entity that this object is "attached to" if this object is a mix-in, otherwise it returns itself.

Parameters:

transactionId - ID for the transaction from where this object is to be retreived

Returns:

Entity that this object is "attached to" if this object is a mix-in, otherwise it returns itself.

Throws:

ServerException - if there is a failure retrieving the structural Entity.

Skip navigation links