OSID Logo
OSID Specifications
messaging package
Version 3.1.0
Interfaceosid.messaging.MessageSearchResults
Implementsosid.OsidSearchResults
Used Byosid.messaging.MessageSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetMessages
Description

Gets the message list resulting from a search.

Returnosid.messaging.MessageList the message list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetMessageQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.messaging.MessageQueryInspector the message query inspector
Compliancemandatory This method must be implemented.
MethodgetMessageSearchResultsRecord
Description

Gets the message search results 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.MessageSearchResultsRecord the message search results record
ErrorsNULL_ARGUMENT messageSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(messageSearchRecordType) is false
Compliancemandatory This method must be implemented.