Interface AddressSearchSession

All Superinterfaces:

AddressQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AddressSearchSession
extends AddressQuerySession

This session provides methods for searching Addresses . 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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface AddressQuerySession

canSearchAddresses, getAddressBook, getAddressBookId, getAddressesByQuery, getAddressQuery, useFederatedAddressBookView, useIsolatedAddressBookView

Modifier and Type	Method	Description
boolean	canSearchAddresses()	Tests if this user can perform Address searches.
AddressBook	getAddressBook()	Gets the AddressBook associated with this session.
Id	getAddressBookId()	Gets the AddressBook Id associated with this session.
AddressList	getAddressesByQuery(AddressQuery addressQuery)	Gets a list of Addresses matching the given search.
AddressQuery	getAddressQuery()	Gets an address query.
void	useFederatedAddressBookView()	Federates the view for methods in this session.
void	useIsolatedAddressBookView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getAddressSearch

AddressSearch getAddressSearch()

Gets an address search.

Returns:

the address search

Compliance:

mandatory - This method must be implemented.

getAddressSearchOrder

AddressSearchOrder getAddressSearchOrder()

Gets an address search order. The AddressSearchOrder is supplied to an AddressSearch to specify the ordering of results.

Returns:

the address search order

Compliance:

mandatory - This method must be implemented.

getAddressesBySearch

AddressSearchResults getAddressesBySearch(AddressQuery addressQuery,
 AddressSearch addressSearch)
                                   throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

addressQuery - the address query

addressSearch - the address search

Returns:

the address search results

Throws:

NullArgumentException - addressQuery or addressSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - addressQuery or addressSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAddressQueryFromInspector

AddressQuery getAddressQueryFromInspector(AddressQueryInspector addressQueryInspector)

Gets an address query from an inspector. The inspector is available from an AddressSearchResults .

Parameters:

addressQueryInspector - an address query inspector

Returns:

the address book query

Throws:

NullArgumentException - addressQueryInspector is null

UnsupportedException - addressQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.