OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressBookSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetAddressBooks
Description

Gets the address book list resulting from a search.

Returnosid.contact.AddressBookListthe address book list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.contact.AddressBookQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookSearchResultsRecord
Description

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

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