|
Oracle Role Manager Java API Reference 10g (10.1.4) E14613-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 String s 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 |
---|
java.lang.String getTitle()
EntityAttribute getAttribute(java.lang.String attributeName)
EntityAttribute
for the provided attribute name.attributeName
- identifier of the attributeEntityAttribute
for the attribute name.java.lang.IllegalArgumentException
- if the attribute is not valid for this object.java.util.Set<java.lang.String> getReadableAttributeNames()
Set
of String
s representing attribute names that the current user has permission to read.Set
of attribute names that the current user has permission to read.BusinessTransactionOperation getOperation(java.lang.String operationId)
operationId
- identifier of the business operationBusinessTransactionOperation
that is "bound" to this object type by its name.EntityKey getEntityKey()
EntityKey
identifier for this Entity
.EntityKey
identifier for this Entity
.ObjectType getObjectType()
ObjectType
of this Entity
.ObjectType
of this Entity
.AuditSummary getAuditSummary() throws ServerException
AuditSummary
for this Entity
.AuditSummary
for this Entity
.ServerException
- if there is a failure retrieving the AuditSummary.ChangeSummary getChangeSummary(java.lang.String attributeName) throws ServerException
ChangeSummary
for this Entity
's attribute.attributeName
- identifier of the attributeChangeSummary
for this Entity
's attribute.ServerException
- if there is a failure retrieving the AuditSummary.HierarchyNode getHierarchyNode(java.lang.String hierarchyType) throws ServerException
HierarchyNode
for this Entity
if it is in a hierarchy, otherwise returns null.hierarchyType
- String
representing the identifier of the hierarchyHierarchyNode
for this Entity
if it is in a hierarchy or null if it is not.ServerException
- if there is a failure retrieving the HierarchyNode.Entity getMixin(java.lang.String mixinType) throws ServerException
Entity
that represents a mix-in attached to this Entity
.mixinType
- identifier of the mix-in typeEntity
that represents a mix-in attached to this Entity
or null if there is no mix-in.ServerException
- if there is a failure retrieving the mix-in Entity
.java.util.List<HierarchyNode> getAllHierarchyNodes() throws ServerException
HierarchyNode
objects that are associated with this Entity
.HierarchyNode
objects associated with this Entity
.ServerException
- if there is a failure retrieving mix-in Entity
objects.java.util.List<Entity> getRelatedObjects(java.lang.String relationshipPath) throws ServerException
relationshipPath
- identifier for the relationship path to traverseServerException
- if there is a failure traversing the relationship path.boolean isMixin()
true
if this Entity is a mix-in, otherwise false
.Entity getStructuralEntity(long transactionId) throws ServerException
transactionId
- ID for the transaction from where this object is to be retreivedServerException
- if there is a failure retrieving the structural Entity
.
|
Oracle Role Manager Java API Reference 10g (10.1.4) E14613-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |