Interface AddressBookSearchSession

All Superinterfaces:

AddressBookQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AddressBookSearchSession
extends AddressBookQuerySession

This session provides methods for searching AddressBooks . The search query is constructed using the AddressBookQuery . The address book record Type also specifies the record for the address book query.

getAddressBooksByQuery() is the basic search method and returns a list of AddressBook elements. A more advanced search may be performed with getAddressBooksBySearch() . It accepts an AddressBookSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAddressBooksBySearch() returns an AddressBookSearchResults that can be used to access the resulting AddressBookList or be used to perform a search within the result set through AddressBookSearch .

AddressBooks may have a query record indicated by their respective record types. The query record is accessed via the AddressBookQuery . The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
AddressBookQuery	getAddressBookQueryFromInspector(AddressBookQueryInspector addressBookQueryInspector)	Gets an address book query from an inspector.
AddressBookSearchResults	getAddressBooksBySearch(AddressBookQuery addressBookQuery, AddressBookSearch addressBookSearch)	Gets the search results matching the given search.
AddressBookSearch	getAddressBookSearch()	Gets an address book search.
AddressBookSearchOrder	getAddressBookSearchOrder()	Gets an address book search order.

Methods inherited from interface AddressBookQuerySession

canSearchAddressBooks, getAddressBookQuery, getAddressBooksByQuery

Modifier and Type	Method	Description
boolean	canSearchAddressBooks()	Tests if this user can perform AddressBook searches.
AddressBookQuery	getAddressBookQuery()	Gets an address book query.
AddressBookList	getAddressBooksByQuery(AddressBookQuery addressBookQuery)	Gets a list of AddressBooks matching the given search.

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

getAddressBookSearch

AddressBookSearch getAddressBookSearch()

Gets an address book search.

Returns:

the address book search

Compliance:

mandatory - This method must be implemented.

getAddressBookSearchOrder

AddressBookSearchOrder getAddressBookSearchOrder()

Gets an address book search order. The AddressBookSearchOrder is supplied to an AddressBookSearch to specify the ordering of results.

Returns:

the address book search order

Compliance:

mandatory - This method must be implemented.

getAddressBooksBySearch

AddressBookSearchResults getAddressBooksBySearch(AddressBookQuery addressBookQuery,
 AddressBookSearch addressBookSearch)
                                          throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

addressBookQuery - the address book query

addressBookSearch - the address book search

Returns:

the address book search results

Throws:

NullArgumentException - addressBookQuery or address books earch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - addressBookQuery or address books earch is not of this service

Compliance:

mandatory - This method must be implemented.

getAddressBookQueryFromInspector

AddressBookQuery getAddressBookQueryFromInspector(AddressBookQueryInspector addressBookQueryInspector)

Gets an address book query from an inspector. The inspector is available from an AddressBookSearchResults .

Parameters:

addressBookQueryInspector - an address book query inspector

Returns:

the address book query

Throws:

NullArgumentException - addressBookQueryInspector is null

UnsupportedException - addressBookQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.