com.ibm.itim.dataservices.model.domain

Class OrganizationSearch

java.lang.Object

com.ibm.itim.dataservices.model.domain.OrganizationSearch

public class OrganizationSearch
extends java.lang.Object

Class that provides an interface for searching for organizations. This interface is supplied to clients so that they can search in a more direct manner without having to traverse data model relationships to retrieve organizations.

See Also:

OrganizationEntity

Constructor Summary

Constructors

Constructor and Description
OrganizationSearch() Default constructor.

Method Summary

Modifier and Type	Method and Description
OrganizationEntity	lookup(DistinguishedName dn) Retrieves the organization with the given distinguished name.
SearchResults	searchByFilter(CompoundDN searchContext, java.lang.String filter, SearchParameters params) Searches for organizations that meet the criteria defined within the given filter.
SearchResults	searchByFilter(DistinguishedName tenantDN, java.lang.String filter, SearchParameters params) Searches for organizations that meet the criteria defined within the given filter.
OrganizationEntity	searchByURI(OrganizationalContainerEntity searchContext, java.lang.String uri) Find the organization for a specific URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrganizationSearch

public OrganizationSearch()

Default constructor.

Method Detail

lookup

public OrganizationEntity lookup(DistinguishedName dn)
                          throws ObjectNotFoundException,
                                 ModelCommunicationException

Retrieves the organization with the given distinguished name.

Parameters:

dn - DistinguishedName to search with.

Returns:

OrganizationEntity matching the given dn.

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.

searchByFilter

public SearchResults searchByFilter(CompoundDN searchContext,
                                    java.lang.String filter,
                                    SearchParameters params)
                             throws ObjectNotFoundException,
                                    ModelCommunicationException

Searches for organizations that meet the criteria defined within the given filter. This search is performed as a raw search against the data store without any semantic mapping.

Parameters:

searchContext - CompoundDN with only one DistinguishedName identifying the tenant (system root) to use as the base of the search.

filter - Filter that defines the criteria for returned organizations to meet. The filter must be in the format defined by RFC2254.

params - SearchParameters that provide additional context for how the search should be performed. Since organizations are only allowed at the top level of an org chart, the scope parameter is not supported.

Returns:

SearchResults holding OrganiationEntities for all organizations that meet the search criteria.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the container specified in the searchContext. This may be due to the container being removed by another client.

searchByFilter

public SearchResults searchByFilter(DistinguishedName tenantDN,
                                    java.lang.String filter,
                                    SearchParameters params)
                             throws ObjectNotFoundException,
                                    ModelCommunicationException

Searches for organizations that meet the criteria defined within the given filter. This search is performed as a raw search against the data store without any semantic mapping.

Parameters:

tenantDN - DistinguishedName of the system root (tenant) to base the search from.

filter - Filter that defines the criteria for returned organizations to meet. The filter must be in the format defined by RFC2254.

params - SearchParameters that provide additional context for how the search should be performed. Since organizations are only allowed at the top level of an org chart, the scope parameter is not supported.

Returns:

SearchResults holding OrganiationEntities for all organizations that meet the search criteria.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the container specified in the searchContext. This may be due to the container being removed by another client.

searchByURI

public OrganizationEntity searchByURI(OrganizationalContainerEntity searchContext,
                                      java.lang.String uri)
                               throws ModelCommunicationException,
                                      URINotUniqueException,
                                      ObjectNotFoundException

Find the organization for a specific URI.

Parameters:

searchContext - OrganizationalContainerEntity which is to be used as the base context to search from.

uri - URI of the organization.

Returns:

OrganizationEntity with the corresponding URI.

Throws:

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

URINotUniqueException - Thrown if more than one object is found for the URI under the specified search context.

ObjectNotFoundException - Thrown if unable to locate the organization or the search context in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.