com.ibm.itim.dataservices.model.domain
Class OrganizationalContainerEntity
java.lang.Object
|
+--com.ibm.itim.dataservices.model.DirectoryObjectEntity
|
+--com.ibm.itim.dataservices.model.domain.OrganizationalContainerEntity
- All Implemented Interfaces:
- java.io.Serializable
- Direct Known Subclasses:
- AdminDomainEntity, BusinessPartnerOrgEntity, BusinessUnitEntity, DirectorySystemEntity, OrganizationEntity
- public class OrganizationalContainerEntity
- extends DirectoryObjectEntity
Class that represents a container in the logical organization chart within
the data model. This class provides a base interface that all specific types
of containers (organizations, locations, etc.) can extend.
- See Also:
- Serialized Form
Methods inherited from class com.ibm.itim.dataservices.model.DirectoryObjectEntity |
equals, getDirectoryObject, getDistinguishedName, getEntity, getParent, getParentDN, getProfile, getRelationship, getSupportedRelationships, hashCode, isSupportedRelationship, remove, remove, toString, update, update |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
OrganizationalContainerEntity
public OrganizationalContainerEntity(OrganizationalContainer container)
- Constructs with the given value object.
- Parameters:
profile
- ObjectProfile identifying the type of container.
OrganizationalContainerEntity
public OrganizationalContainerEntity(ObjectProfile profile,
OrganizationalContainer container)
- Constructs with the given value object and object profile.
- Parameters:
profile
- ObjectProfile identifying the type of container.container
- OrganizationalContainer value object.
hasDependencies
public boolean hasDependencies()
throws ModelCommunicationException
- Returns whether there are any dependent entities within the container.
- Returns:
- True if dependents are present, false if not.
- Throws:
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
getParentContainer
public OrganizationalContainerEntity getParentContainer()
throws ModelCommunicationException,
ModelIntegrityException
- Returns the parent organizational container (if any). Since these
containers can be recursively stacked in a hierarchy, clients will
often wish to traverse the hierarchy. This method will support that
capability.
- Returns:
- OrganizationalContainerEntity which contains this object, null
if no parent exists.
- Throws:
ModelCommunicationException
- Thrown if unable to communicate
with the data store.ModelIntegrityException
- Thrown if a parent container
relationship has been identified, but the system is unable to
locate the parent entity in the data store. This may be due to
a data integrity problem, or the entity may have been removed
by another client.
getLogicalNameContext
public CompoundDN getLogicalNameContext()
- Returns the compound distinguished name structure that can be used
as a context for searching for entities contained within this
container or placing entities within this container. This method
may be overridden in derived classes.
- Returns:
- CompoundDN representing the context.