Skip navigation links

oracle.iam.rm.server_api
Interface ServerEntity

All Superinterfaces:

java.io.Serializable

public interface ServerEntity

extends java.io.Serializable

The server representation of an Entity. <p/> This is not normally referred to directly by consuming systems that instead would use the Client API's Entity interface.

See Also:

Entity

Method Summary

SecuredValue	getAttributeValue(java.lang.String attributeName) Gets the SecuredValue that represents the provided attribute.
EntityKey	getEntityKey() Gets the EntityKey that is used to identify this object on the server.
ObjectType	getObjectType() Gets the ObjectType of this object.
java.util.Set	getReadableAttributeNames() Gets a set of attribute names that are "readable" by the caller.
EntityKey	getStructuralObjectEntityKey() Either gets the EntityKey of the object that this object is "attached to" if this object is a mix-in, otherwise returns null.
long	getTransactionId() Gets the ID of the transaction that this object is bound to or Server.NO_TRANSACTION if it is not bound to a transaction.
boolean	isMixin() Determines whether this ServerEntity is a mixin.

Method Detail

getAttributeValue

SecuredValue getAttributeValue(java.lang.String attributeName)

Gets the SecuredValue that represents the provided attribute.

Parameters:

attributeName - name of the attribute to return

Returns:

SecuredValue that represents the provided attribute.

getReadableAttributeNames

java.util.Set getReadableAttributeNames()

Gets a set of attribute names that are "readable" by the caller.

Returns:

Set of attribute names that are "readable" by the caller.

getEntityKey

EntityKey getEntityKey()

Gets the EntityKey that is used to identify this object on the server.

Returns:

EntityKey that is used to identify this object on the server.

getObjectType

ObjectType getObjectType()

Gets the ObjectType of this object.

Returns:

ObjectType of this object.

getTransactionId

long getTransactionId()

Gets the ID of the transaction that this object is bound to or Server.NO_TRANSACTION if it is not bound to a transaction.

Returns:

ID of the transaction that this object is bound to, otherwise NO_TRANSACTION.

isMixin

boolean isMixin()

Determines whether this ServerEntity is a mixin.

Returns:

Boolean true if this ServerEntity is a mixin, otherwise false.

getStructuralObjectEntityKey

EntityKey getStructuralObjectEntityKey()
                                       throws ServerException

Either gets the EntityKey of the object that this object is "attached to" if this object is a mix-in, otherwise returns null.

Returns:

EntityKey of the object that this object is "attached to" if this object is a mix-in, otherwise returns null.

Throws:

ServerException

Skip navigation links