|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.itim.dataservices.model.DirectoryObjectEntity
Class that represents an entry in the directory. The most general relationships that entry has in the data model can be traversed through the interface of this class. The ability to update and remove an entry in the data store is also provided.
Field Summary | |
---|---|
static java.lang.String |
ORGANIZATION
Constant (String) for the organization relationship name |
static java.lang.String |
PARENT
Constant (String) for the parent relationship name. |
Constructor Summary | |
---|---|
DirectoryObjectEntity(DirectoryObject dirObject)
Creates a DirectoryObjectEntity representing an entity in directory server. |
|
DirectoryObjectEntity(ObjectProfile profile,
DirectoryObject dirObject)
Creates a DirectoryObjectEntity representing an entity in directory server. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object dirEntity)
Determine whether the two object reference the same entity in term of Distinguished name. |
DirectoryObject |
getDirectoryObject()
Returns the DirectoryObject value object that holds the attributes of this object. |
DistinguishedName |
getDistinguishedName()
Returns the distinguished name of the object. |
static DirectoryObjectEntity |
getEntity(DirectoryObject dirObject)
Returns the parent of the current object. |
EntityLifecycleProfile |
getLifecycle()
Returns the EntityLifecycleProfile holding all lifecycle characteristics of the entity (if defined). |
DirectoryObjectEntity |
getParent()
Returns the parent of the current object. |
DistinguishedName |
getParentDN()
Retrieve the DistinguishedName of the parent of the current object. |
ObjectProfile |
getProfile()
Returns the profile of the object. |
Relationship |
getRelationship(java.lang.String name)
Returns a relationship with the given name, if any. |
java.util.Collection |
getSupportedRelationships()
Returns a list of relationship names this entity supports. |
int |
hashCode()
Create hash code based on raw distinguished name string |
boolean |
isSupportedRelationship(java.lang.String name)
Returns whether the relationship with the given name is supported by this entity. |
void |
remove()
Removes the entity from the data store. |
void |
remove(boolean copyToRecycle)
Removes the entity from the data store. |
void |
setLifecycle(EntityLifecycleProfile profile)
Changes the EntityLifecycleProfile holding all lifecycle characteristics of the entity (if defined). |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates the attributes of the entity in the data store. |
void |
update(DirectoryObject updObject)
Deprecated. please use update() |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String PARENT
public static final java.lang.String ORGANIZATION
Constructor Detail |
public DirectoryObjectEntity(ObjectProfile profile, DirectoryObject dirObject)
profile
- profile describing a type of an entity object.dirObject
- directory object contains data of an entitypublic DirectoryObjectEntity(DirectoryObject dirObject)
dirObject
- directory object contains data of an entityMethod Detail |
public DistinguishedName getDistinguishedName()
public DirectoryObject getDirectoryObject()
public ObjectProfile getProfile() throws ModelCommunicationException, ObjectNotFoundException
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ObjectNotFoundException
- Thrown if unable to locate the
related profile. This may be due to a data integrity problem.public DirectoryObjectEntity getParent() throws ModelCommunicationException, ModelIntegrityException
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ModelIntegrityException
- Thrown if unable to locate the
related parent due to a data integrity problem.public DistinguishedName getParentDN() throws ModelCommunicationException, ModelIntegrityException
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ModelIntegrityException
- Thrown if unable to locate the
related parent due to a data integrity problem.public static DirectoryObjectEntity getEntity(DirectoryObject dirObject) throws ModelIntegrityException
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ModelIntegrityException
- Thrown if unable to locate the
related parent due to a data integrity problem.public void update(DirectoryObject updObject) throws ModelCommunicationException, ObjectNotFoundException
updObject
- DirectoryObject that holds the changes.
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ObjectNotFoundException
- Thrown if unable to locate the
entity in the data store. This may be due to a data integrity
problem, or the entity may have been removed by another
client.public void update() throws ModelCommunicationException, ObjectNotFoundException
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ObjectNotFoundException
- Thrown if unable to locate the
entity in the data store. This may be due to a data integrity
problem, or the entity may have been removed by another
client.public void remove() throws ModelCommunicationException, ObjectNotFoundException, ModelRemoveException
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ObjectNotFoundException
- Thrown if unable to locate the
entity in the data store. This may be due to a data integrity
problem, or the entity may have already been removed by
another client.
ModelRemoveException
- Thrown if unable to remove an object
of the data store.public void remove(boolean copyToRecycle) throws ModelCommunicationException, ObjectNotFoundException, ModelRemoveException
copyToRecycle
- If true the object will be copied to the recycle bin before being deleted
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ObjectNotFoundException
- Thrown if unable to locate the
entity in the data store. This may be due to a data integrity
problem, or the entity may have already been removed by
another client.
ModelRemoveException
- Thrown if unable to remove an object
of the data store.public Relationship getRelationship(java.lang.String name) throws ObjectNotFoundException, ModelIntegrityException, java.lang.InstantiationException
name
- Name of the relationship.
ModelIntegrityException
- Thrown if unable to access meta-data
to find relationship.
ObjectNotFoundException
- Thrown if unable to locate a
relationship with the same name.
java.lang.InstantiationException
- Thrown if unable to instantiate the
relationship found with the same name.public java.util.Collection getSupportedRelationships() throws ModelIntegrityException, ObjectNotFoundException
ModelIntegrityException
- Thrown if unable to access meta-data
to find relationships.
ObjectNotFoundException
- Thrown if unable to meta-data
information about this class.public boolean isSupportedRelationship(java.lang.String name) throws ModelIntegrityException, ObjectNotFoundException
name
- Name of the relationship.
ModelIntegrityException
- Thrown if unable to access meta-data
to find relationships.
ObjectNotFoundException
- Thrown if unable to meta-data
information about this class.public EntityLifecycleProfile getLifecycle() throws ModelCommunicationException, ModelIntegrityException
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ModelIntegrityException
- Thrown if unable to access lifecycle
information.public void setLifecycle(EntityLifecycleProfile profile) throws ModelCommunicationException, ObjectNotFoundException, ModelIntegrityException
profile
- EntityLifecycleProfile with lifecycle characteristics.
Null will remove all characteristics previously defined.
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ModelIntegrityException
- Thrown if unable to set lifecycle
information.
ObjectNotFoundException
- Thrown if unable to locate the
entity in the data store. This may be due to an invalid
distinguished name, or the entity may have been removed by
another client.public boolean equals(java.lang.Object dirEntity)
equals
in class java.lang.Object
dirEntity
- the target entity for comparison.
java.lang.IllegalArgumentException
- Thrown if dirEntity is not an instance of
DirectoryObjectEntity.public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |