com.ibm.itim.dataservices.model.domain

Class ContainedEntityParent

java.lang.Object

com.ibm.itim.dataservices.model.domain.ContainedEntityParent

All Implemented Interfaces:

Relationship

public class ContainedEntityParent
extends java.lang.Object
implements Relationship

The ContainedEntityParent class implements the parent relationship to an entity that is contained within an OrganizationalContainer. The subject of this relationship is a DirectoryObjectEntity and the participant is 0 or 1 OrganizationalContainers that act as the entity's parent.

Constructor Summary

Constructors

Constructor and Description
ContainedEntityParent()

Method Summary

Modifier and Type	Method and Description
boolean	doesParticipate(DirectoryObjectEntity participant) Determines if the given entity is the parent of the subject entity.
java.util.Collection	evaluate() Evaluates the relationship returning 0 or one OrganizationalContainerEntity objects that represent the parent of the subject entity.
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

ContainedEntityParent

public ContainedEntityParent()

Method Detail

setSubject

public void setSubject(DirectoryObjectEntity entity)

Sets the subject entity for the relationship.

Specified by:

setSubject in interface Relationship

Parameters:

entity - DirectoryObjectEntity acting as the subject of this relationship.

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.

evaluate

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

Evaluates the relationship returning 0 or one OrganizationalContainerEntity objects that represent the parent of the subject entity.

Specified by:

evaluate in interface Relationship

Returns:

Collection of 0 or one OrganizationalContainerEntity objects.

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.

Specified by:

doesParticipate in interface Relationship

Parameters:

participant - Proposed parent (DirectoryObjectEntity). Note: the participant must be an OrganizationalContainerEntity to be considered.

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.