public interface AddressSearchSession extends AddressQuerySession
This session provides methods for searching Address
objects. The search query is constructed using the AddressQuery.
The address record Type
also specifies the record
for the address query.
getAddressesByQuery()
is the basic search method and
returns a list of Address
elements. A more advanced search
may be performed with getAddressesBySearch().
It accepts an
AddressSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getAddressesBySearch()
returns an
AddressSearchResults
that can be used to access the resulting
AddressList
or be used to perform a search within the
result set through AddressSearch.
Addresses may have a query record indicated by their respective record
types. The query record is accessed via the AddressQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
AddressSearchResults |
getAddressesBySearch(AddressQuery addressQuery,
AddressSearch addressSearch)
Gets the search results matching the given search.
|
AddressQuery |
getAddressQueryFromInspector(AddressQueryInspector addressQueryInspector)
Gets an address query from an inspector.
|
AddressSearch |
getAddressSearch()
Gets an address search.
|
AddressSearchOrder |
getAddressSearchOrder()
Gets an address search order.
|
canSearchAddresses, getAddressBook, getAddressBookId, getAddressesByQuery, getAddressQuery, useFederatedAddressBookView, useIsolatedAddressBookView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AddressSearch getAddressSearch()
mandatory
- This method must be implemented. AddressSearchOrder getAddressSearchOrder()
AddressSearchOrder
is
supplied to an AddressSearch
to specify the ordering of
results.mandatory
- This method must be implemented. AddressSearchResults getAddressesBySearch(AddressQuery addressQuery, AddressSearch addressSearch) throws OperationFailedException, PermissionDeniedException
addressQuery
- the address queryaddressSearch
- the address searchNullArgumentException
- addressQuery
or
addressSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- addressQuery
or
addressSearch
is not of this servicemandatory
- This method must be implemented. AddressQuery getAddressQueryFromInspector(AddressQueryInspector addressQueryInspector)
AddressSearchResults.
addressQueryInspector
- an address query inspectorNullArgumentException
- addressQueryInspector
is null
UnsupportedException
- addressQueryInspector
is not of this servicemandatory
- This method must be implemented.