OSID Logo
OSID Specifications
contact package
Version 3.0.0
Interfaceosid.contact.ContactSearch
Implementsosid.OsidSearch
Used Byosid.contact.ContactSearchSession
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_ARGUMENTcontactIds is null
CompliancemandatoryThis method must be implemented.
MethodorderContactResults
Description

Specify an ordering to the search results.

Parametersosid.contact.ContactSearchOrdercontactSearchOrdercontact search order
ErrorsNULL_ARGUMENTcontactSearchOrder is null
UNSUPPORTEDcontactSearchOrder 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_ARGUMENTcontactSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(contactSearchRecordType) is false
CompliancemandatoryThis method must be implemented.