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

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

All Implemented Interfaces:

java.io.Serializable

public class OrganizationalContainerSearch
extends java.lang.Object
implements java.io.Serializable

Class that provides an interface for searching for organizational containers. 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 organizational containers.

See Also:

OrganizationalContainerEntity, Serialized Form

Constructor Summary

OrganizationalContainerSearch()
Default constructor.

Method Summary

OrganizationalContainerEntity	lookup(DistinguishedName dn) Searches for a organizational container object with the given distinguished name.
SearchResults	searchByFilter(CompoundDN searchContext, java.lang.String filter, SearchParameters params) Searches for organizational containers that meet the criteria defined within the given filter.
SearchResults	searchByFilter(CompoundDN searchContext, java.lang.String objProfileName, java.lang.String filter, SearchParameters params) Searches for organizational containers that meet the criteria defined within the given filter.
SearchResults	searchByFilter(OrganizationalContainerEntity searchContext, java.lang.String filter, SearchParameters params) Searches for organizational containers that meet the criteria defined within the given filter.
OrganizationalContainerEntity	searchByURI(OrganizationalContainerEntity searchContext, java.lang.String uri) Find the organizational container for a specific URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrganizationalContainerSearch

public OrganizationalContainerSearch()

Default constructor.

Method Detail

lookup

public OrganizationalContainerEntity lookup(DistinguishedName dn)
                                     throws ObjectNotFoundException,
                                            ModelCommunicationException

Searches for a organizational container object with the given distinguished name.

Parameters:

dn - DistinguishedName to search with.

Returns:

OrganizationalContainerEntity 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(OrganizationalContainerEntity searchContext,
                                    java.lang.String filter,
                                    SearchParameters params)
                             throws ModelCommunicationException,
                                    ObjectNotFoundException

Searches for organizational containers 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 - OrganizationalContainerEntity which is to be used as the base context to search from.

filter - Filter that defines the criteria for returned containers 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. If the search scope is ONELEVEL_SCOPE, the search is limited only to the dynamic roles belong to the passing parent (searchContext.last()). Otherwise, the whole organizational logical subtree will be searched.

Returns:

SearchResults holding OrganizationalContainerEntities for all organizational containers 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(CompoundDN searchContext,
                                    java.lang.String filter,
                                    SearchParameters params)
                             throws ModelCommunicationException,
                                    ObjectNotFoundException

Searches for organizational containers 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 that defines the base of the search. At least one (1) element and at most three (3) are expected:

• searchContext.elements[0] must contain the tenant DN
• searchContext.elements[1] may contain the organization DN
• searchContext.elements[2] may contain the parent DN (optional)

filter - Filter that defines the criteria for returned containers 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. If the search scope is ONELEVEL_SCOPE, the search is limited only to the dynamic roles belong to the passing parent (searchContext.last()). Otherwise, the whole organizational logical subtree will be searched.

Returns:

SearchResults holding OrganizationalContainerEntities for all organizational containers 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 OrganizationalContainerEntity searchByURI(OrganizationalContainerEntity searchContext,
                                                 java.lang.String uri)
                                          throws ModelCommunicationException,
                                                 URINotUniqueException,
                                                 ObjectNotFoundException

Find the organizational container for a specific URI.

Parameters:

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

uri - URI of the organizational container.

Returns:

OrganizationalContainerEntity 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 organizational container 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.

searchByFilter

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

Searches for organizational containers 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 that defines the base of the search. At least one (1) element and at most three (3) are expected:

• searchContext.elements[0] must contain the tenant DN
• searchContext.elements[1] may contain the organization DN
• searchContext.elements[2] may contain the parent DN (optional)

An element cannot be skipped. For example, you can not pass the parent DN without passing the organization DN.

objProfileName - Name of the ObjectProfile that defines the type of organizational container (i.e., Location, Organizational Unit, Admin Domain, etc.) to search for. If empty string passed, organizational containers of all types will be returned.

filter - Filter that defines the criteria for returned business units 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. If the search scope is ONELEVEL_SCOPE, the search is limited only to the business units belong to the given parent (searchContext.last()). Otherwise, the whole organizational logical subtree will be searched.

Returns:

SearchResults holding OrganizationalContainerEntities for all organizational containers 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.