com.ibm.itim.dataservices.model.domain
Class Supervisor
java.lang.Object
|
+--com.ibm.itim.dataservices.model.domain.Supervisor
- All Implemented Interfaces:
- Relationship
- public class Supervisor
- extends java.lang.Object
- implements Relationship
The Supervisor class implements the supervisor
relationship to a business unit or person. The subject of this relationship
is a BusinessUnitEntity or PersonEntity and the participant is 0 or 1 PersonEntities that
act as the entity's supervisor.
Method Summary |
boolean |
doesParticipate(DirectoryObjectEntity participant)
Determines if the given entity is an supervisor of the subject entity. |
java.util.Collection |
evaluate()
Evaluates the relationship returning 0 or one PersonEntity objects that
represents the supervisor 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 |
Supervisor
public Supervisor()
setSubject
public void setSubject(DirectoryObjectEntity entity)
- Sets the subject entity for the relationship. This entity must be
an BusinessUnitEntity or a PersonEntity.
- Specified by:
setSubject
in interface Relationship
- Parameters:
entity
- DirectoryObjectEntity acting as the subject of this
relationship. This object must be an BusinessUnitEntity or a
PersonEntity.
evaluate
public java.util.Collection evaluate()
throws ModelIntegrityException,
ModelCommunicationException
- Evaluates the relationship returning 0 or one PersonEntity objects that
represents the supervisor of the subject entity. The supervisor is the
first person designated as a supervisor as an attribute of the entity
itself or one of its parents. The search through the entity's parents
is performed from the entity upward to the root of the organization.
- Specified by:
evaluate
in interface Relationship
- Returns:
- Collection of 0, one, or many PersonEntity 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.
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 an supervisor of the subject entity.
The given entity must be a PersonEntity to even be considered as
supervisor.
- Specified by:
doesParticipate
in interface Relationship
- Parameters:
participant
- Proposed supervisor (DirectoryObjectEntity).- Returns:
- True if participant is supervisor, 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.