com.ibm.itim.dataservices.model.domain
Class DirectorySystemSearch
java.lang.Object
|
+--com.ibm.itim.dataservices.model.domain.DirectorySystemSearch
- public class DirectorySystemSearch
- extends java.lang.Object
Class that provides an interface for searching for directory systems. This
interface only provides the ability to search by distinguished name and by
id.
- See Also:
DirectorySystemEntity
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DirectorySystemSearch
public DirectorySystemSearch()
- Default constructor.
lookup
public DirectorySystemEntity lookup(DistinguishedName dn)
throws ObjectNotFoundException,
ModelCommunicationException
- Retrieves the directory system (tenant) from the data store with the
given distinguished name.
- Parameters:
dn
- DistinguishedName of the directory system (tenant).- Returns:
- DirectorySystemEntity with the corresponding distinguished name.
- 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 an invalid
distinguished name, or the entity may have been removed by
another client.
searchById
public DirectorySystemEntity searchById(java.lang.String id)
throws ObjectNotFoundException,
ModelCommunicationException
- Retrieves the directory system (tenant) from the data store with the
given id (name).
- Parameters:
id
- ID (name) of the directory system (tenant).- Returns:
- DirectorySystemEntity with the corresponding id (name).
- 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 an invalid
distinguished name, or the entity may have been removed by
another client.
getAll
public java.util.Collection getAll()
throws ObjectNotFoundException,
ModelCommunicationException
- Retrieves all directory systems (tenant) from the data store.
- Returns:
- list of directory systems (DirectorySystemEntity).
- Throws:
ModelCommunicationException
- Thrown if unable to communicate
with the data store.ObjectNotFoundException
- Thrown if unable to locate the
entities in the data store. This may be due to an invalid
distinguished name, or entities may have been removed by
another client.
lookupDefault
public DirectorySystemEntity lookupDefault()
throws ObjectNotFoundException,
ModelCommunicationException
- Retrieves the default directory system (tenant) from the data store.
- Returns:
- Default DirectorySystemEntity.
- 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 an invalid
distinguished name, the entity may have been removed by
another client, or there is a problem finding the properties
file that stores the default tenant id.