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

The search interface for governing contact searches.

MethodsearchAmongContacts
Description

Execute this search among the given list of contacts.

Parametersosid.id.IdListcontactIdslist of contacts
ErrorsNULL_ARGUMENT contactIds is null
CompliancemandatoryThis method must be implemented.
MethodorderContactResults
Description

Specify an ordering to the search results.

Parametersosid.contact.ContactSearchOrdercontactSearchOrdercontact search order
ErrorsNULL_ARGUMENT contactSearchOrder is null
UNSUPPORTED contactSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetContactSearchRecord
Description

Gets the contact search 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.ContactSearchRecordthe contact search record
ErrorsNULL_ARGUMENT contactSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(contactSearchRecordType) is false
CompliancemandatoryThis method must be implemented.