com.ibm.itim.dataservices.model.domain

Class DirectorySystemEntity

java.lang.Object

com.ibm.itim.dataservices.model.DirectoryObjectEntity

com.ibm.itim.dataservices.model.domain.OrganizationalContainerEntity

com.ibm.itim.dataservices.model.domain.DirectorySystemEntity

All Implemented Interfaces:

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

public class DirectorySystemEntity
extends OrganizationalContainerEntity

Class that represents the root node for the system (tenant) in the data model and holds the system (tenant) wide configuration settings.

See Also:

Serialized Form

Field Summary

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

Constructors

Constructor and Description
DirectorySystemEntity(DirectoryObject dirObj) Constructs an DirectorySystemEntity with a value object.
DirectorySystemEntity(DirectorySystem dirSystem) Constructs an AccountEntity with a value object.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Challenge>	getChallenges() Returns the challenge questions of password challenge and response.
CompoundDN	getLogicalNameContext() Returns the compound distinguished name structure that can be used as a context for searching for entities contained within this container or placing entities within this container.
MailTemplateConfigurationEntity	getMailTemplateConfigurationEntity() Returns the configuration for mail template.
DirectoryObjectEntity	getParent() Returns the parent of the directory system, which since the directory system represents the root of the system (tenant), will return null.
POConfigurationEntity	getPOConfigurationEntity() Returns the configuration for Post Office notification.
WorkflowConfigurationEntity	getWorkflowConfigurationEntity() Returns the configuration for workflow reminder and activity.
void	setChallenges(java.util.Collection questions) Changes challenge questions of password challenge and response.

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

getOrganization, getParentContainer, hasDependencies, moveOrgTree

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

equals, getDirectoryObject, getDistinguishedName, getEntity, getLifecycle, getObjectCategory, 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

Constructor Detail

DirectorySystemEntity

public DirectorySystemEntity(DirectorySystem dirSystem)

Constructs an AccountEntity with a value object.

Parameters:

dirSystem - DirectorySystem object holding the attributes of the directory system.

DirectorySystemEntity

public DirectorySystemEntity(DirectoryObject dirObj)

Constructs an DirectorySystemEntity with a value object.

Parameters:

dirSystem - DirectoryObject holding the attributes of the directory system.

Method Detail

getParent

public DirectoryObjectEntity getParent()

Returns the parent of the directory system, which since the directory system represents the root of the system (tenant), will return null.

Overrides:

getParent in class DirectoryObjectEntity

Returns:

null.

getChallenges

public java.util.Collection<Challenge> getChallenges()
                                              throws ModelCommunicationException,
                                                     ObjectNotFoundException

Returns the challenge questions of password challenge and response.

Returns:

Collection of Challenges.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the related challenge questions. This may be due to a data integrity problem.

setChallenges

public void setChallenges(java.util.Collection questions)
                   throws ModelCommunicationException,
                          ObjectNotFoundException

Changes challenge questions of password challenge and response.

Parameters:

questions - Collection of Challenges.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the related challenge questions. This may be due to a data integrity problem.

getPOConfigurationEntity

public POConfigurationEntity getPOConfigurationEntity()
                                               throws ModelCommunicationException,
                                                      ObjectNotFoundException

Returns the configuration for Post Office notification.

Returns:

An object that contains all configuration for Post Office notification.

Throws:

ModelCommunicationException

ObjectNotFoundException

getWorkflowConfigurationEntity

public WorkflowConfigurationEntity getWorkflowConfigurationEntity()
                                                           throws ModelCommunicationException,
                                                                  ObjectNotFoundException

Returns the configuration for workflow reminder and activity.

Returns:

An object that contains all configuration for workflow reminder and activity.

Throws:

ModelCommunicationException

ObjectNotFoundException

getMailTemplateConfigurationEntity

public MailTemplateConfigurationEntity getMailTemplateConfigurationEntity()
                                                                   throws ModelCommunicationException,
                                                                          ObjectNotFoundException

Returns the configuration for mail template.

Returns:

An object that contains all configuration for mailt templates.

Throws:

ModelCommunicationException

ObjectNotFoundException

getLogicalNameContext

public CompoundDN getLogicalNameContext()

Returns the compound distinguished name structure that can be used as a context for searching for entities contained within this container or placing entities within this container.

Overrides:

getLogicalNameContext in class OrganizationalContainerEntity

Returns:

CompoundDN representing the context.