com.ibm.itim.dataservices.model.domain
Class AdminDomainEntity

java.lang.Object
  com.ibm.itim.dataservices.model.DirectoryObjectEntity
      com.ibm.itim.dataservices.model.domain.OrganizationalContainerEntity
          com.ibm.itim.dataservices.model.domain.AdminDomainEntity

All Implemented Interfaces:

com.ibm.itim.util.Sortable, java.io.Serializable

public class AdminDomainEntity
extends OrganizationalContainerEntity

Class that represents a admin domain in the logical organization chart within the data model.

See Also:

Serialized Form

Field Summary

static java.lang.String

ADMINISTRATOR Constant (String) for the organization relationship name.

Fields inherited from class com.ibm.itim.dataservices.model.DirectoryObjectEntity

ORGANIZATION, PARENT

Fields inherited from interface com.ibm.itim.util.Sortable

ATTR_NAME

Constructor Summary

AdminDomainEntity(AdminDomain domain)
Constructs an AdminDomainEntity with a value object.

AdminDomainEntity(DirectoryObject domain)
Constructs an AdminDomainEntity, taking a DirectoryObject as parameter.

AdminDomainEntity(ObjectProfile profile, AdminDomain domain)
Constructs an AdminDomainEntity with a profile and value object.

Method Summary

void	addAdministrator(PersonEntity administrator) Adds the given administrator to the domain.
java.util.Collection	getAdministrators() Returns the administrators for the administrative domain.
OrganizationEntity	getOrganization() Returns the organization that contains the admin domain.
void	removeAdministrator(PersonEntity administrator) Removes the given administrator from the domain.
void	setAdministrators(java.util.Collection administrators) Changes the administrators for the domain.

Methods inherited from class com.ibm.itim.dataservices.model.domain.OrganizationalContainerEntity

getLogicalNameContext, getParentContainer, hasDependencies

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryObjectEntity

equals, getDirectoryObject, getDistinguishedName, getEntity, getLifecycle, getObjectCategory, getParent, getParentDN, getProfile, getRelationship, getSortValue, getSupportedRelationships, hashCode, initialize, initialize, isSupportedRelationship, remove, remove, setLifecycle, toString, update, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ADMINISTRATOR

public static final java.lang.String ADMINISTRATOR

Constant (String) for the organization relationship name.

See Also:

Constant Field Values

Constructor Detail

AdminDomainEntity

public AdminDomainEntity(ObjectProfile profile,
                         AdminDomain domain)

Constructs an AdminDomainEntity with a profile and value object.

Parameters:

profile - Profile identifying the type of this admin domain.

domain - AdminDomain object holding the attributes of the admin domain.

AdminDomainEntity

public AdminDomainEntity(AdminDomain domain)

Constructs an AdminDomainEntity with a value object.

Parameters:

domain - AdminDomain object holding the attributes of the admin domain.

AdminDomainEntity

public AdminDomainEntity(DirectoryObject domain)

Constructs an AdminDomainEntity, taking a DirectoryObject as parameter.

Parameters:

domain - DirectoryObject object holding the attributes of the admin domain.

Method Detail

getAdministrators

public java.util.Collection getAdministrators()
                                       throws ModelCommunicationException,
                                              ModelIntegrityException

Returns the administrators for the administrative domain. A domain can have zero to many administrator(s).

Returns:

Collection of PersonEntities representing the administrators of the domain.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ModelIntegrityException - Thrown if a problem exists with the consistency of the data model preventing the evaluation of the relationship.

setAdministrators

public void setAdministrators(java.util.Collection administrators)
                       throws ModelCommunicationException,
                              ObjectNotFoundException

Changes the administrators for the domain.

Parameters:

administrators - Collection of PersonEntity objects to be the new administrator(s).

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the admin domain in the data store. This may be due to a data integrity problem, or the entity may have been removed by another client.

addAdministrator

public void addAdministrator(PersonEntity administrator)
                      throws ModelCommunicationException,
                             ObjectNotFoundException

Adds the given administrator to the domain.

Parameters:

administrator - PersonEntity representing the new administrator for the domain.

Throws:

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.

removeAdministrator

public void removeAdministrator(PersonEntity administrator)
                         throws ModelCommunicationException,
                                ObjectNotFoundException

Removes the given administrator from the domain.

Parameters:

administrator - PersonEntity representing the adminstrator to remove.

Throws:

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.

getOrganization

public OrganizationEntity getOrganization()
                                   throws ModelCommunicationException,
                                          ModelIntegrityException

Returns the organization that contains the admin domain.

Returns:

OrganizationEntity representing the object's organization.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ModelIntegrityException - Thrown if unable to locate the entity's organization.