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

java.lang.Object
  |
  +--com.ibm.itim.dataservices.model.domain.OrganizationParent

All Implemented Interfaces:

Relationship

public class OrganizationParent

extends java.lang.Object

implements Relationship

The OrganizationParent class implements the parent relationship to an OrganizationEntity. The subject of this relationship is an OrganizationEntity and the participant is a DirectorySystemEntity that acts as the organization's parent.

Constructor Summary

OrganizationParent()

Method Summary

boolean	doesParticipate(DirectoryObjectEntity participant) Determines if the given entity is the parent of the subject entity.
java.util.Collection	evaluate() Evaluates the relationship returning the DirectorySystemEntity object that represents the parent of the subject organization.
java.util.Collection	evaluateReferences() Evaluates the relationship returning 0 to many entity DNs that participate opposite the subject entity.
void	setSubject(DirectoryObjectEntity entity) Sets the subject entity for the relationship.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrganizationParent

public OrganizationParent()

Method Detail

setSubject

public void setSubject(DirectoryObjectEntity entity)

Sets the subject entity for the relationship. This entity must be an OrganizationEntity.

Specified by:

setSubject in interface Relationship

Parameters:

entity - DirectoryObjectEntity acting as the subject of this relationship. This object must be an OrganizationEntity.

evaluate

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

Evaluates the relationship returning the DirectorySystemEntity object that represents the parent of the subject organization.

Specified by:

evaluate in interface Relationship

Returns:

Collection of one DirectorySystemEntity object.

Throws:

ModelIntegrityException - Thrown if a problem exists with the consistency of the data model preventing the relationship from being evaluated properly.

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

evaluateReferences

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

Evaluates the relationship returning 0 to many entity DNs that participate opposite the subject entity.

Specified by:

evaluateReferences in interface Relationship

Returns:

Collection of DistinguishedName instances that participate.

Throws:

ModelIntegrityException - Thrown if a problem exists with the consistency of the data model preventing the relationship from being evaluated properly.

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

doesParticipate

public boolean doesParticipate(DirectoryObjectEntity participant)
                        throws ModelIntegrityException,
                               ModelCommunicationException

Determines if the given entity is the parent of the subject entity. The given entity must be a DirectorySystemEntity to even be considered as parent.

Specified by:

doesParticipate in interface Relationship

Parameters:

participant - Proposed parent (DirectoryObjectEntity).

Returns:

True if participant is the parent, false if not.

Throws:

ModelIntegrityException - Thrown if a problem exists with the consistency of the data model preventing the relationship from being evaluated properly.

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