OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MessageSearch
Implementsosid.OsidSearch
Description

The search interface for governing message searches.

MethodsearchAmongMessages
Description

Execute this search among the given list of messages.

Parametersosid.id.IdListmessageIdslist of message Ids
ErrorsNULL_ARGUMENT messageIds is null
CompliancemandatoryThis method must be implemented.
MethodorderMessageResults
Description

Specify an ordering to the search results.

Parametersosid.messaging.MessageSearchOrdermessageSearchOrdermessage search order
ErrorsNULL_ARGUMENT messageSearchOrder is null
UNSUPPORTED messageSearchOrder is not of this service
CompliancemandatoryThis 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.TypemessageSearchRecordTypea message search record type
Returnosid.messaging.records.MessageSearchRecordthe message search record
ErrorsNULL_ARGUMENT messageSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(messageSearchRecordType) is false
CompliancemandatoryThis method must be implemented.