OSID Logo
OSID Specifications
messaging package
Version 3.1.0
Interfaceosid.messaging.MessageSearch
Implementsosid.OsidSearch
Used Byosid.messaging.MessageSearchSession
Description

The search interface for governing message searches.

MethodsearchAmongMessages
Description

Execute this search among the given list of messages.

Parametersosid.id.IdListmessageIds list of message Ids
ErrorsNULL_ARGUMENT messageIds is null
Compliancemandatory This method must be implemented.
MethodorderMessageResults
Description

Specify an ordering to the search results.

Parametersosid.messaging.MessageSearchOrdermessageSearchOrder message search order
ErrorsNULL_ARGUMENT messageSearchOrder is null
UNSUPPORTED messageSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetMessageSearchRecord
Description

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

Parametersosid.type.TypemessageSearchRecordType a message search record type
Returnosid.messaging.records.MessageSearchRecord the message search record
ErrorsNULL_ARGUMENT messageSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(messageSearchRecordType) is false
Compliancemandatory This method must be implemented.