com.ibm.itim.dataservices.model
Interface Relationship

All Known Implementing Classes:

AccountOwner, AccountParent, AccountService, AdminDomainAdministrator, BusinessPartnerSponsor, ContainedEntityParent, DirectoryObjectOrganization, DirectoryObjectParent, OrganizationParent, PersonAccount, PersonRole, PersonSelf, ServiceOwner, Supervisor

public interface Relationship

The Relationship interface provides the method signature of all relationship implementations in the data model. One relationship is unidirectional, with one entity as the subject. Evaluating a relationship returns the entities that participate on the other end.

Method Summary

boolean	doesParticipate(DirectoryObjectEntity participant) Determines if the given entity participates in the relationship.
java.util.Collection	evaluate() Evaluates the relationship returning 0 to many entities that participate opposite 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.

Method Detail

setSubject

public void setSubject(DirectoryObjectEntity entity)

Sets the subject entity for the relationship.

Parameters:

entity - DirectoryObjectEntity acting as the subject of this relationship.

evaluate

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

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

Returns:

Collection of DirectoryObjectEntities 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.

evaluateReferences

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

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

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 participates in the relationship.

Parameters:

participant - Proposed participant (DirectoryObjectEntity).

Returns:

True if entity participates, 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.