public interface OrganizationSearchSession extends OrganizationQuerySession
This session provides methods for searching Organization
objects. The search query is constructed using the
OrganizationQuery.
The organization record Type
also specifies the record for the organization query.
getOrganizationsByQuery()
is the basic search method
and returns a list of Organization
elements. A more
advanced search may be performed with getOrganizationsBySearch().
It accepts an OrganizationSearch
in addition to the
query for the purpose of specifying additional options affecting the
entire search, such as ordering. getOrganizationsBySearch()
returns an OrganizationSearchResults
that can be used to
access the resulting OrganizationList
or be used to perform
a search within the result set through OrganizationSearch.
This session defines views that offer differing behaviors for searching.
Organizations may have a query record indicated by their respective
record types. The query record is accessed via the
OrganizationQuery.
The returns in this session may not be cast
directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
OrganizationQuery |
getOrganizationQueryFromInspector(OrganizationQueryInspector organizationQueryInspector)
Gets an organization query from an inspector.
|
OrganizationSearchResults |
getOrganizationsBySearch(OrganizationQuery organizationQuery,
OrganizationSearch organizationSearch)
Gets the search results matching the given search.
|
OrganizationSearch |
getOrganizationSearch()
Gets an organization search.
|
OrganizationSearchOrder |
getOrganizationSearchOrder()
Gets an organization search order.
|
canSearchOrganizations, getOrganizationQuery, getOrganizationsByQuery, getRealm, getRealmId, useFederatedRealmView, useIsolatedRealmView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
OrganizationSearch getOrganizationSearch()
mandatory
- This method must be implemented. OrganizationSearchOrder getOrganizationSearchOrder()
OrganizationSearchOrder
is supplied to an OrganizationSearch
to specify
the ordering of results.mandatory
- This method must be implemented. OrganizationSearchResults getOrganizationsBySearch(OrganizationQuery organizationQuery, OrganizationSearch organizationSearch) throws OperationFailedException, PermissionDeniedException
organizationQuery
- the organization queryorganizationSearch
- the organization searchNullArgumentException
- organizationQuery
or organizationSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- organizationQuery
or organizationSearch
is not of this servicemandatory
- This method must be implemented. OrganizationQuery getOrganizationQueryFromInspector(OrganizationQueryInspector organizationQueryInspector)
OrganizationSearchResults.
organizationQueryInspector
- an organization query inspectorNullArgumentException
-
organizationQueryInspector
is null
UnsupportedException
-
organizationQueryInspector
is not of this servicemandatory
- This method must be implemented.