OSID Logo
OSID Specifications
contact package
Version 3.1.0
Interfaceosid.contact.AddressBookSearch
Implementsosid.OsidSearch
Used Byosid.contact.AddressBookSearchSession
Description

The search interface for governing address book searches.

MethodsearchAmongAddressBooks
Description

Execute this search among the given list of address books.

Parametersosid.id.IdListaddressBookIds list of address books
ErrorsNULL_ARGUMENT addressBookIds is null
Compliancemandatory This method must be implemented.
MethodorderAddressBookResults
Description

Specify an ordering to the search results.

Parametersosid.contact.AddressBookSearchOrderaddressBooksearchOrder address book search order
ErrorsNULL_ARGUMENT addressBooksearchOrder is null
UNSUPPORTED addressBooksearchOrder is not of this service
Compliancemandatory This 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.TypeaddressBookSearchRecordType an address book search record type
Returnosid.contact.records.AddressBookSearchRecord the address book search record
ErrorsNULL_ARGUMENT addressBooksearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(addressBooksearchRecordType) is false
Compliancemandatory This method must be implemented.