org.osid.contact

Interface AddressBookSearchSession

All Superinterfaces:

AddressBookQuerySession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AddressBookSearchSession
extends AddressBookQuerySession

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

Methods

Modifier and Type	Method and 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 org.osid.contact.AddressBookQuerySession

canSearchAddressBooks, getAddressBookQuery, getAddressBooksByQuery

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.