Interface MessageSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface MessageSearch
extends OsidSearch

The search interface for governing message searches.

Method Summary

Modifier and Type	Method	Description
MessageSearchRecord	getMessageSearchRecord(Type messageSearchRecordType)	Gets the message search record corresponding to the given message search record Type.
void	orderMessageResults(MessageSearchOrder messageSearchOrder)	Specify an ordering to the search results.
void	searchAmongMessages(IdList messageIds)	Execute this search among the given list of messages.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongMessages

void searchAmongMessages(IdList messageIds)

Execute this search among the given list of messages.

Parameters:

messageIds - list of message Ids

Throws:

NullArgumentException - messageIds is null

Compliance:

mandatory - This method must be implemented.

orderMessageResults

void orderMessageResults(MessageSearchOrder messageSearchOrder)

Specify an ordering to the search results.

Parameters:

messageSearchOrder - message search order

Throws:

NullArgumentException - messageSearchOrder is null

UnsupportedException - messageSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getMessageSearchRecord

MessageSearchRecord getMessageSearchRecord(Type messageSearchRecordType)
                                    throws OperationFailedException

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.

Parameters:

messageSearchRecordType - a message search record type

Returns:

the message search record

Throws:

NullArgumentException - messageSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(messageSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.