|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.itim.dataservices.model.DirectoryObjectSearch
Class that provides searching capabilities for DirectoryObjects. 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 objects.
DirectoryObjectEntity
Constructor Summary | |
---|---|
DirectoryObjectSearch()
Default constructor. |
Method Summary | |
---|---|
SearchResults |
fetch(DistinguishedName base,
java.lang.String filter,
SearchParameters params)
Searches for DirectoryObjects that meet the criteria defined within the given filter. |
DirectoryObjectEntity |
lookup(DistinguishedName dn)
Searches for a directory object with the given distinguished name. |
java.util.Collection |
search(DistinguishedName base,
java.lang.String filter,
SearchParameters params)
Deprecated. Replaced by fetch(base, filter, params). |
SearchResults |
searchByClass(DistinguishedName base,
java.lang.String className,
SearchParameters params)
Searches for DirectoryObjects of the given class. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DirectoryObjectSearch()
Method Detail |
public DirectoryObjectEntity lookup(DistinguishedName dn) throws ObjectNotFoundException, ModelCommunicationException
dn
- DistinguishedName to search with.
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.public java.util.Collection search(DistinguishedName base, java.lang.String filter, SearchParameters params) throws ModelCommunicationException, ObjectNotFoundException
base
- DistinguishedName of the data store entry to be used as the
base of any search.filter
- Filter that defines the criteria for returned
DirectoryObects 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.
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ObjectNotFoundException
- Thrown if unable to locate the
specified search base. This may be due to a data integrity
problem or the base entry may have been removed by another
client.public SearchResults searchByClass(DistinguishedName base, java.lang.String className, SearchParameters params) throws ModelCommunicationException, ObjectNotFoundException
base
- DistinguishedName of the data store entry to be used as the
base of any search.className
- Name of the class to search for.params
- SearchParameters that provide additional context for
how the search should be performed.
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ObjectNotFoundException
- Thrown if unable to locate the
specified search base. This may be due to a data integrity
problem or the base entry may have been removed by another
client.public SearchResults fetch(DistinguishedName base, java.lang.String filter, SearchParameters params) throws ModelCommunicationException, ObjectNotFoundException
base
- DistinguishedName of the data store entry to be used as the
base of any search.filter
- Filter that defines the criteria for returned
DirectoryObects 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.
ModelCommunicationException
- Thrown if unable to communicate
with the data store.
ObjectNotFoundException
- Thrown if unable to locate the
specified search base. This may be due to a data integrity
problem or the base entry may have been removed by another
client.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |