public interface ContactEnablerSearchSession extends ContactEnablerQuerySession
This session provides methods for searching among ContactEnabler
objects. The search query is constructed using the
ContactEnableryQuery.
getContactEnablersByQuery()
is the basic search method
and returns a list of ContactEnablers.
A more advanced
search may be performed with getContactEnablersBySearch().
It accepts a ContactEnablerSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as ordering. getContactEnablersBySearch()
returns a ContactEnablerSearchResults
that can be used to
access the resulting ContactEnablerList
or be used to
perform a search within the result set through
ContactEnablerSearch.
This session defines views that offer differing behaviors for searching.
ContactEnablers
may have a query record indicated by
their respective record types. The query record is accessed via the
ContactEnablerQuery.
Modifier and Type | Method and Description |
---|---|
ContactEnablerQuery |
getContactEnablerQueryFromInspector(ContactEnablerQueryInspector contactEnablerQueryInspector)
Gets a contact enabler query from an inspector.
|
ContactEnablerSearchResults |
getContactEnablersBySearch(ContactEnablerQuery contactEnablerQuery,
ContactEnablerSearch contactEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
ContactEnablerSearch |
getContactEnablerSearch()
Gets a contact enabler search.
|
ContactEnablerSearchOrder |
getContactEnablerSearchOrder()
Gets a contact enabler search order.
|
canSearchContactEnablers, getAddressBook, getAddressBookId, getContactEnablerQuery, getContactEnablersByQuery, useFederatedAddressBookView, useIsolatedAddressBookView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ContactEnablerSearch getContactEnablerSearch()
mandatory
- This method must be implemented. ContactEnablerSearchOrder getContactEnablerSearchOrder()
ContactEnablerSearchOrder
is supplied to a
ContactEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. ContactEnablerSearchResults getContactEnablersBySearch(ContactEnablerQuery contactEnablerQuery, ContactEnablerSearch contactEnablerSearch) throws OperationFailedException, PermissionDeniedException
contactEnablerQuery
- the contact enabler querycontactEnablerSearch
- the contact enabler searchNullArgumentException
- contactEnablerQuery
or contactEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- contactEnablerQuery
or contactEnablerSearch
is not of this
servicemandatory
- This method must be implemented. ContactEnablerQuery getContactEnablerQueryFromInspector(ContactEnablerQueryInspector contactEnablerQueryInspector)
ContactEnablerSearchResults.
contactEnablerQueryInspector
- a contact enabler query inspectorNullArgumentException
-
contactEnablerQueryInspector
is null
UnsupportedException
-
contactEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.