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

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

MethodgetContacts
Description

Gets the contact list resulting from a search.

Returnosid.contact.ContactListthe contact list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetContactQueryInspector
Description

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

Returnosid.contact.ContactQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetContactSearchResultsRecord
Description

Gets the contact search results record corresponding to the given contact search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypecontactSearchRecordTypea contact search record type
Returnosid.contact.records.ContactSearchResultsRecordthe contact search record
ErrorsNULL_ARGUMENT contactSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(contactSearchRecordType) is false
CompliancemandatoryThis method must be implemented.