OSID Logo
OSID Specifications
contact package
Version 3.1.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.IdListcontactIds list of contacts
ErrorsNULL_ARGUMENT contactIds is null
Compliancemandatory This method must be implemented.
MethodorderContactResults
Description

Specify an ordering to the search results.

Parametersosid.contact.ContactSearchOrdercontactSearchOrder contact search order
ErrorsNULL_ARGUMENT contactSearchOrder is null
UNSUPPORTED contactSearchOrder is not of this service
Compliancemandatory This 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.TypecontactSearchRecordType a contact search record type
Returnosid.contact.records.ContactSearchRecord the contact search record
ErrorsNULL_ARGUMENT contactSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(contactSearchRecordType) is false
Compliancemandatory This method must be implemented.