|
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.EntityRelationManager
public class EntityRelationManager
Class for handling entity relationship operations like read, create, delete, and search relationship
Method Summary | |
---|---|
void |
createEntityRelationship(java.lang.String relationshipName, Entity fromEntity, Entity toEntity, CreateOptions createOpts) Creates specified entity relationship between given two entities |
void |
createEntityRelationship(java.lang.String relationshipName, java.lang.String fromEntityId, java.lang.String toEntityId, CreateOptions createOpts) Creates specified entity relationship between given two entities |
void |
deleteEntityRelationship(java.lang.String relationshipName, Entity fromEntity, Entity toEntity, DeleteOptions deleteOpts) Deletes specified entity relationship between given two entities |
void |
deleteEntityRelationship(java.lang.String relationshipName, java.lang.String fromEntityId, java.lang.String toEntityId, DeleteOptions deleteOpts) Deletes specified entity relationship between given two entities |
boolean |
entityRelationExists(java.lang.String relationshipName, Entity fromEntity, Entity toEntity, ReadOptions readOpts) Checks if the specified entity relationship exists between given two entities |
boolean |
entityRelationExists(java.lang.String relationshipName, java.lang.String fromEntityId, java.lang.String toEntityId, ReadOptions readOpts) Checks if the specified entity relationship exists between given two entities |
EntityRelationship |
getEntityRelationship(java.lang.String entityRelationshipName) Gets entity relationship definition for given entity relationship name |
java.util.List<EntityRelationship> |
getEntityRelationships() Gets all entity relationships defined in entity configuration |
ResultSet |
searchEntityRelationship(java.lang.String relationshipName, Entity fromEntity, int nestedLevels, SearchFilter targetFilter, SearchOptions searchOpts) Searches related entities for a given entity and specified entity relationship |
ResultSet |
searchEntityRelationship(java.lang.String relationshipName, java.lang.String fromEntityId, int nestedLevels, SearchFilter targetFilter, SearchOptions searchOpts) Searches related entities for a given entity and specified entity relationship |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public boolean entityRelationExists(java.lang.String relationshipName, java.lang.String fromEntityId, java.lang.String toEntityId, ReadOptions readOpts) throws IDSException, EntityNotFoundException, AuthorizationException, EntityNotUniqueException
relationshipName
- Name of relationshipfromEntityId
- First entity idtoEntityId
- Second entity idreadOpts
- Read optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If any of the given two entities not foundAuthorizationException
- If user does not have sufficient privilegesEntityNotUniqueException
public boolean entityRelationExists(java.lang.String relationshipName, Entity fromEntity, Entity toEntity, ReadOptions readOpts) throws IDSException, AuthorizationException, EntityNotFoundException
relationshipName
- Name of relationshipfromEntity
- First entitytoEntity
- Second entityreadOpts
- Read optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If any of the given two entities not foundAuthorizationException
- If user does not have sufficient privilegespublic void createEntityRelationship(java.lang.String relationshipName, java.lang.String fromEntityId, java.lang.String toEntityId, CreateOptions createOpts) throws IDSException, EntityAlreadyExistsException, EntityNotFoundException, EntityNotUniqueException, AuthorizationException, OperationNotSupportedException
relationshipName
- Name of the entity relationshipfromEntityId
- First entity idtoEntityId
- Second entity idcreateOpts
- Create optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If any of the given two entities not foundEntityNotUniqueException
- If more than one entity found matching given entity idOperationNotSupportedException
- If the entity relationship creation is not supportedAuthorizationException
- If user does not have sufficient privilegesEntityAlreadyExistsException
public void createEntityRelationship(java.lang.String relationshipName, Entity fromEntity, Entity toEntity, CreateOptions createOpts) throws IDSException, EntityAlreadyExistsException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
relationshipName
- Name of the entity relationshipfromEntity
- First entitytoEntity
- Second entitycreateOpts
- Create optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If any of the given two entities not foundOperationNotSupportedException
- If the entity relationship creation is not supportedAuthorizationException
- If user does not have sufficient privilegesEntityAlreadyExistsException
public void deleteEntityRelationship(java.lang.String relationshipName, java.lang.String fromEntityId, java.lang.String toEntityId, DeleteOptions deleteOpts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, EntityNotUniqueException
relationshipName
- Name of the entity relationshipfromEntityId
- First entity idtoEntityId
- Second entity iddeleteOpts
- Delete optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If any of the given two entities not foundEntityNotUniqueException
- If more than one entity found matching given entity idOperationNotSupportedException
- If the entity relationship creation is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void deleteEntityRelationship(java.lang.String relationshipName, Entity fromEntity, Entity toEntity, DeleteOptions deleteOpts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
relationshipName
- Name of the entity relationshipfromEntity
- First entitytoEntity
- Second entitydeleteOpts
- Delete optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If any of the given two entities not foundEntityNotUniqueException
- If more than one entity found matching given entity idOperationNotSupportedException
- If the entity relationship creation is not supportedAuthorizationException
- If user does not have sufficient privilegespublic ResultSet searchEntityRelationship(java.lang.String relationshipName, java.lang.String fromEntityId, int nestedLevels, SearchFilter targetFilter, SearchOptions searchOpts) throws IDSException, EntityNotFoundException, EntityNotUniqueException, AuthorizationException, OperationNotSupportedException
relationshipName
- Name of the entity relationshipfromEntityId
- Entity from which the related entities to be foundnestedLevels
- number of levels to be searched for recursive relationships. 0 means all the levels.targetFilter
- Search filter to be applied on the related entitiessearchOpts
- Search optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If any of the given two entities not foundEntityNotUniqueException
- If more than one entity found matching given entity idAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public ResultSet searchEntityRelationship(java.lang.String relationshipName, Entity fromEntity, int nestedLevels, SearchFilter targetFilter, SearchOptions searchOpts) throws IDSException, AuthorizationException, OperationNotSupportedException
relationshipName
- Name of the entity relationshipfromEntity
- Entity from which the related entities to be foundnestedLevels
- number of levels to be searched for recursive relationships. 0 means all the levels.targetFilter
- Search filter to be applied on the related entitiessearchOpts
- Search optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If any of the given two entities not foundEntityNotUniqueException
- If more than one entity found matching given entity idAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public java.util.List<EntityRelationship> getEntityRelationships()
public EntityRelationship getEntityRelationship(java.lang.String entityRelationshipName)
entityRelationshipName
- Name of the entity relationship
|
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 |