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

java.lang.Object
  com.ibm.itim.dataservices.model.domain.OwnershipTypeConfiguration

public class OwnershipTypeConfiguration
extends java.lang.Object

This class provides support to read/add/change/remove ownership types stored in LDAP. Ownership type name is unique.

Constructor Summary

OwnershipTypeConfiguration(DistinguishedName tenantDN)

Method Summary

void	addOwnershipType(OwnershipType newType) Add the ownership type in LDAP, name must be unique.
OwnershipType	getOwnershipType(OwnershipType ownershipTypeInfo) Returns the ownership type by name (name has to be unique).
java.util.Collection	getOwnershipTypes() Returns all the available ownership types.
void	removeOwnershipType(OwnershipType type) Remove the ownership type.
void	updateOwnershipType(OwnershipType updatedTypeInfo) Updates the ownership type in the data store.

Methods inherited from class java.lang.Object

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

Constructor Detail

OwnershipTypeConfiguration

public OwnershipTypeConfiguration(DistinguishedName tenantDN)

Parameters:

tenantDN - tenant DN where the ownership type is stored at.

Method Detail

addOwnershipType

public void addOwnershipType(OwnershipType newType)
                      throws ModelCommunicationException,
                             ModelCreationException

Add the ownership type in LDAP, name must be unique.

Parameters:

newType - OwnershipType to create.

Throws:

ModelCommunicationException

ModelCreationException

updateOwnershipType

public void updateOwnershipType(OwnershipType updatedTypeInfo)
                         throws ObjectNotFoundException,
                                ModelCommunicationException

Updates the ownership type in the data store. Only description can be changed.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to a data integrity problem, or the entity may have been removed by another client.

removeOwnershipType

public void removeOwnershipType(OwnershipType type)
                         throws ModelCommunicationException,
                                ModelRemoveException,
                                ObjectNotFoundException

Remove the ownership type. Only non-default types can be removed.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to a data integrity problem, or the entity may have already been removed by another client.

ModelRemoveException - Thrown if unable to remove the entity of the data store.

getOwnershipType

public OwnershipType getOwnershipType(OwnershipType ownershipTypeInfo)
                               throws ModelCommunicationException,
                                      ObjectNotFoundException

Returns the ownership type by name (name has to be unique).

Throws:

ModelCommunicationException

ObjectNotFoundException

getOwnershipTypes

public java.util.Collection getOwnershipTypes()
                                       throws ModelCommunicationException,
                                              ObjectNotFoundException

Returns all the available ownership types.

Returns:

Collection of available OwnershipType.

Throws:

ModelCommunicationException

ObjectNotFoundException