com.ibm.itim.dataservices.model.system

Class SystemRoleSearch

java.lang.Object

com.ibm.itim.dataservices.model.system.SystemRoleSearch

public class SystemRoleSearch
extends java.lang.Object

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

See Also:

SystemRoleEntity

Constructor Summary

Constructors

Constructor and Description
SystemRoleSearch() Default constructor.

Method Summary

Modifier and Type	Method and Description
SystemRoleEntity	lookup(DistinguishedName dn) Retrieves the system role from the data store with the given distinguished name.
SearchResults	searchByCategory(CompoundDN searchContext, int category, SearchParameters params) Retrieves all system roles within the given category.
SearchResults	searchByCategory(OrganizationalContainerEntity searchContext, int category, SearchParameters params) Retrieves all system roles within the given category.
SearchResults	searchByFilter(CompoundDN searchContext, java.lang.String filter, SearchParameters params) Searches for system roles that meet the criteria defined within the given filter.
SearchResults	searchByFilter(OrganizationalContainerEntity searchContext, java.lang.String filter, SearchParameters params) Searches for system roles that meet the criteria defined within the given filter.
SearchResults	searchByName(CompoundDN searchContext, java.lang.String name, SearchParameters params) Retrieves all system roles within the given name.
SystemRoleEntity	searchByURI(OrganizationalContainerEntity searchContext, java.lang.String uri) Find the system role for a specific URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemRoleSearch

public SystemRoleSearch()

Default constructor.

Method Detail

lookup

public SystemRoleEntity lookup(DistinguishedName dn)
                        throws ModelCommunicationException,
                               ObjectNotFoundException

Retrieves the system role from the data store with the given distinguished name.

Parameters:

dn - DistinguishedName to search with.

Returns:

SystemRoleEntity with the corresponding distinguished name.

Throws:

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

ObjectNotFoundException - is 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 system roles 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 system roles 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 system roles that belong to the given parent (searchContext.last()). Otherwise, the whole organizational logical subtree will be searched.

Returns:

SearchResults holding SystemRoleEntities for all system roles 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 system roles 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.

filter - Filter that defines the criteria for returned system roles 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 system roles that belong to the given parent (searchContext.last()). Otherwise, the selected container subtree will be searched.

Returns:

SearchResults holding SystemRoleEntities for all system roles 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.

searchByCategory

public SearchResults searchByCategory(OrganizationalContainerEntity searchContext,
                                      int category,
                                      SearchParameters params)
                               throws ModelCommunicationException,
                                      ObjectNotFoundException

Retrieves all system roles within the given category.

Parameters:

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

category - Enumeration of the category to search for.

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 system roles that belong to the given parent (searchContext.last()). Otherwise, the whole organizational logical subtree will be searched.

Returns:

SearchResults holding SystemRoleEntities for all system roles in the given category.

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.

searchByCategory

public SearchResults searchByCategory(CompoundDN searchContext,
                                      int category,
                                      SearchParameters params)
                               throws ModelCommunicationException,
                                      ObjectNotFoundException

Retrieves all system roles within the given category.

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.

category - Enumeration of the category to search for.

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 system roles that belong to the given parent (searchContext.last()). Otherwise, the whole organizational logical subtree will be searched.

Returns:

SearchResults holding SystemRoleEntities for all system roles in the given category.

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.

searchByName

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

Retrieves all system roles within the given name.

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.

name - Name of the role to search for.

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 system roles that belong to the given parent (searchContext.last()). Otherwise, the whole organizational logical subtree will be searched.

Returns:

SearchResults holding SystemRoleEntities for all system roles in the given name.

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 SystemRoleEntity searchByURI(OrganizationalContainerEntity searchContext,
                                    java.lang.String uri)
                             throws ModelCommunicationException,
                                    URINotUniqueException,
                                    ObjectNotFoundException

Find the system role for a specific URI.

Parameters:

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

uri - URI of the policy.

Returns:

SystemRoleEntity 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 system role 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.