OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MessageSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetMessages
Description

Gets the message list resulting from a search.

Returnosid.messaging.MessageListthe message list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetMessageQueryInspector
Description

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

Returnosid.messaging.MessageQueryInspectorthe message query inspector
CompliancemandatoryThis 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.TypemessageSearchRecordTypea message search record type
Returnosid.messaging.records.MessageSearchResultsRecordthe message search results record
ErrorsNULL_ARGUMENT messageSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(messageSearchRecordType) is false
CompliancemandatoryThis method must be implemented.