OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressBookSearchSession
Implementsosid.contact.AddressBookQuerySession
Description

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.

MethodgetAddressBookSearch
Description

Gets an address book search.

Returnosid.contact.AddressBookSearchthe address book search
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookSearchOrder
Description

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

Returnosid.contact.AddressBookSearchOrderthe address book search order
CompliancemandatoryThis method must be implemented.
MethodgetAddressBooksBySearch
Description

Gets the search results matching the given search.

Parametersosid.contact.AddressBookQueryaddressBookQuerythe address book query
osid.contact.AddressBookSearchaddressBookSearchthe address book search
Returnosid.contact.AddressBookSearchResultsthe address book search results
ErrorsNULL_ARGUMENT addressBookQuery or address books earch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED addressBookQuery or address books earch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookQueryFromInspector
Description

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

Parametersosid.contact.AddressBookQueryInspectoraddressBookQueryInspectoran address book query inspector
Returnosid.contact.AddressBookQuerythe address book query
ErrorsNULL_ARGUMENT addressBookQueryInspector is null
UNSUPPORTED addressBookQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.