|
Oracle Fusion Middleware Identity Governance Framework Identity Directory Java API Reference 11g Release 1 (11.1.1) E39432-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.igf.ids.Entity
public class Entity
This is generic entity class holding the list of attributes of the entity fetched using search or read methods. This generic entity class also holds the EntityManager handle and provides methods to modify attribute values in the repository and the methods for getting the related entities per the entity relationship definitions.
Method Summary | |
---|---|
Entity |
clone() Clones this object |
java.util.Map<java.lang.String,Attribute> |
getAllAttributes() Gets map of all entity attributes |
Attribute |
getAttribute(java.lang.String attrName) Gets Entity Attribute |
java.lang.String |
getAttributeLocaleValue(java.lang.String attrName, java.util.Locale locale) Gets attribute locale value |
java.lang.String |
getAttributeValue(java.lang.String attrName) Gets first attribute value |
java.lang.String |
getCanonicalName() Gets entity canonical name |
java.lang.String |
getEntityName() Gets entity name |
java.lang.String |
getGuid() Gets entity Guid value |
java.lang.String |
getId() Gets entity ID attribute value |
java.lang.String |
getName() Gets entity name value |
java.security.Principal |
getPrincipal() Gets principal identifier of the entity |
ResultSet |
getRelatedEntities(java.lang.String relationshipName, int nestedLevels, SearchFilter targetFilter, SearchOptions searchOpts) Gets all related entities for given entity relationship |
java.lang.String |
getSubjectName() Gets entity subjectname |
void |
modify(java.util.List<ModAttribute> attrVals, ModifyOptions opts) Modifies entity attribute values |
void |
setAttributeValue(java.lang.String attrName, java.lang.String attrVal, ModifyOptions opts) Modifies entity attribute value |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public Attribute getAttribute(java.lang.String attrName)
attrName
- Name of the attributepublic java.lang.String getAttributeValue(java.lang.String attrName)
attrName
- Name of the attributepublic java.util.Map<java.lang.String,Attribute> getAllAttributes()
public java.lang.String getAttributeLocaleValue(java.lang.String attrName, java.util.Locale locale)
attrName
- Attribute namelocale
- Locale valuepublic java.lang.String getEntityName()
public java.security.Principal getPrincipal()
public java.lang.String getSubjectName()
public java.lang.String getCanonicalName()
public java.lang.String getId()
public java.lang.String getName()
public java.lang.String getGuid()
public void modify(java.util.List<ModAttribute> attrVals, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
attrVals
- List of mod attribute valuesopts
- Modify operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When the entity to be modified is not foundOperationNotSupportedException
- When this entity modify operation is not supportedInvalidAttributesException
- When the mod attributes are invalidAuthorizationException
- If user does not have sufficient privilegespublic void setAttributeValue(java.lang.String attrName, java.lang.String attrVal, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
attrName
- Attribute nameattrVal
- Attribute valueopts
- Modify operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When the entity to be modified is not foundOperationNotSupportedException
- When this entity modify operation is not supportedInvalidAttributesException
- When the input attribute is invalidAuthorizationException
- If user does not have sufficient privilegespublic ResultSet getRelatedEntities(java.lang.String relationshipName, int nestedLevels, SearchFilter targetFilter, SearchOptions searchOpts) throws EntityNotFoundException, IDSException, InvalidAttributesException, AuthorizationException, OperationNotSupportedException
relationshipName
- Entity relationship name to be processednestedLevels
- Number of nested levels the related entiteis to be fetchedtargetFilter
- Search filter to be used against the related entitiessearchOpts
- Search operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If the entity for which related entities to be fetched is not foundInvalidAttributesException
- If the requested attributes or the attributes in the target search filter are invalidAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public Entity clone()
clone
in class java.lang.Object
|
Oracle Fusion Middleware Identity Governance Framework Identity Directory Java API Reference 11g Release 1 (11.1.1) E39432-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |