|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.itim.dataservices.model.domain.BusinessPartnerOrgSearch
Class that provides an interface for searching for business partner 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 business partner organizations.
BusinessPartnerEntity
Constructor Summary | |
---|---|
BusinessPartnerOrgSearch()
Default constructor. |
Method Summary | |
---|---|
BusinessPartnerOrgEntity |
lookup(DistinguishedName dn)
Retrieves the business partner organization with the given distinguished name. |
SearchResults |
searchByFilter(CompoundDN searchContext,
java.lang.String filter,
SearchParameters params)
Searches for business partner organizations that meet the criteria defined within the given filter. |
SearchResults |
searchByFilter(OrganizationalContainerEntity searchContext,
java.lang.String filter,
SearchParameters params)
Searches for business partner organizations that meet the criteria defined within the given filter. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BusinessPartnerOrgSearch()
Method Detail |
public BusinessPartnerOrgEntity lookup(DistinguishedName dn) throws ModelCommunicationException, ObjectNotFoundException
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 SearchResults searchByFilter(OrganizationalContainerEntity searchContext, java.lang.String filter, SearchParameters params) throws ObjectNotFoundException, ModelCommunicationException
searchContext
- OrganizationalContainerEntity which is to be used
as the base context to search from.filter
- Filter that defines the criteria for returned
business partner 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.
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 logical subtree will be searched.
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.public SearchResults searchByFilter(CompoundDN searchContext, java.lang.String filter, SearchParameters params) throws ObjectNotFoundException, ModelCommunicationException
searchContext
- CompoundDN that defines the base of the search.
At least one (1) element and at most three (3)
are expected:
filter
- Filter that defines the criteria for returned
business partner 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.
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 logical subtree will be searched.
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.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |