OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressBookSearch
Implementsosid.OsidSearch
Description

The search interface for governing address book searches.

MethodsearchAmongAddressBooks
Description

Execute this search among the given list of address books.

Parametersosid.id.IdListaddressBookIdslist of address books
ErrorsNULL_ARGUMENT addressBookIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAddressBookResults
Description

Specify an ordering to the search results.

Parametersosid.contact.AddressBookSearchOrderaddressBooksearchOrderaddress book search order
ErrorsNULL_ARGUMENT addressBooksearchOrder is null
UNSUPPORTED addressBooksearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookSearchRecord
Description

Gets the address book search record corresponding to the given address book search record Type. This method is used to retrieve an object implementing the requested record interface.

Parametersosid.type.TypeaddressBookSearchRecordTypean address book search record type
Returnosid.contact.records.AddressBookSearchRecordthe address book search record
ErrorsNULL_ARGUMENT addressBooksearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(addressBooksearchRecordType) is false
CompliancemandatoryThis method must be implemented.