public interface ContactSearchSession extends ContactQuerySession
This session provides methods for searching Contact
objects. The search query is constructed using the ContactQuery.
The contact record Type
also specifies the record
for the contact query.
getContactsByQuery()
is the basic search method and
returns a list of AddressBook
elements. A more advanced
search may be performed with getContactsBySearch().
It
accepts a ContactSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as ordering. getContactsBySearch()
returns a
ContactSearchResults
that can be used to access the resulting
ContactList
or be used to perform a search within the
result set through ContactSearch.
Contacts may have a query record indicated by their respective record
types. The query record is accessed via the ContactQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
ContactQuery |
getContactQueryFromInspector(ContactQueryInspector contactQueryInspector)
Gets a contact query from an inspector.
|
ContactSearchResults |
getContactsBySearch(ContactQuery contactQuery,
ContactSearch contactSearch)
Gets the search results matching the given search.
|
ContactSearch |
getContactSearch()
Gets a contact search.
|
ContactSearchOrder |
getContactSearchOrder()
Gets a contact search order.
|
canSearchContacts, getAddressBook, getAddressBookId, getContactQuery, getContactsByQuery, useFederatedAddressBookView, useIsolatedAddressBookView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ContactSearch getContactSearch()
mandatory
- This method must be implemented. ContactSearchOrder getContactSearchOrder()
ContactSearchOrder
is
supplied to a ContactSearch
to specify the ordering of
results.mandatory
- This method must be implemented. ContactSearchResults getContactsBySearch(ContactQuery contactQuery, ContactSearch contactSearch) throws OperationFailedException, PermissionDeniedException
contactQuery
- the contact querycontactSearch
- the contact searchNullArgumentException
- contactQuery
or
contactSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- contactQuery
or
contactSearch
is not of this servicemandatory
- This method must be implemented. ContactQuery getContactQueryFromInspector(ContactQueryInspector contactQueryInspector)
ContactSearchResults.
contactQueryInspector
- a contact query inspectorNullArgumentException
- contactQueryInspector
is null
UnsupportedException
- contactQueryInspector
is not of this servicemandatory
- This method must be implemented.