org.osid.messaging

Interface MessageSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface MessageSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
MessageSearchOrderRecord	getMessageSearchOrderRecord(Type messageRecordType) Gets the message search order record corresponding to the given message record Type.
ReceiptSearchOrder	getReceiptSearchOrder() Gets the receipt order.
ResourceSearchOrder	getSenderSearchOrder() Gets the resource order.
AgentSearchOrder	getSendingAgentSearchOrder() Gets the sending agent order.
void	orderByDeliveryTime(SearchOrderStyle style) Specifies a preference for ordering messages by the delivery time.
void	orderByReceipt(SearchOrderStyle style) Specifies a preference for ordering messages by receipt.
void	orderByReceivedTime(SearchOrderStyle style) Specifies a preference for ordering messages by the sent time.
void	orderBySender(SearchOrderStyle style) Specifies a preference for ordering messages by sender.
void	orderBySendingAgent(SearchOrderStyle style) Specifies a preference for ordering messages by sending agent.
void	orderBySent(SearchOrderStyle style) Specifies a preference for ordering messages by sent.
void	orderBySentTime(SearchOrderStyle style) Specifies a preference for ordering messages by the sent time.
void	orderBySubjectLine(SearchOrderStyle style) Specifies a preference for ordering messages by subject line.
void	orderByText(SearchOrderStyle style) Specifies a preference for ordering messages by text.
boolean	supportsReceiptSearchOrder() Tests if a receipt order is available.
boolean	supportsSenderSearchOrder() Tests if a resource order is available.
boolean	supportsSendingAgentSearchOrder() Tests if an agent order is available.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

orderBySubjectLine

void orderBySubjectLine(SearchOrderStyle style)

Specifies a preference for ordering messages by subject line.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByText

void orderByText(SearchOrderStyle style)

Specifies a preference for ordering messages by text.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySent

void orderBySent(SearchOrderStyle style)

Specifies a preference for ordering messages by sent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySentTime

void orderBySentTime(SearchOrderStyle style)

Specifies a preference for ordering messages by the sent time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySender

void orderBySender(SearchOrderStyle style)

Specifies a preference for ordering messages by sender.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSenderSearchOrder

boolean supportsSenderSearchOrder()

Tests if a resource order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSenderSearchOrder

ResourceSearchOrder getSenderSearchOrder()

Gets the resource order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsSenderSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsSenderSearchOrder() is true.

orderBySendingAgent

void orderBySendingAgent(SearchOrderStyle style)

Specifies a preference for ordering messages by sending agent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSendingAgentSearchOrder

boolean supportsSendingAgentSearchOrder()

Tests if an agent order is available.

Returns:

true if an agent order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSendingAgentSearchOrder

AgentSearchOrder getSendingAgentSearchOrder()

Gets the sending agent order.

Returns:

the agent search order

Throws:

UnimplementedException - supportsSendingAgentSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsSendingAgentSearchOrder() is true.

orderByReceivedTime

void orderByReceivedTime(SearchOrderStyle style)

Specifies a preference for ordering messages by the sent time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDeliveryTime

void orderByDeliveryTime(SearchOrderStyle style)

Specifies a preference for ordering messages by the delivery time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByReceipt

void orderByReceipt(SearchOrderStyle style)

Specifies a preference for ordering messages by receipt.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsReceiptSearchOrder

boolean supportsReceiptSearchOrder()

Tests if a receipt order is available.

Returns:

true if a receipt order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getReceiptSearchOrder

ReceiptSearchOrder getReceiptSearchOrder()

Gets the receipt order.

Returns:

the receipt search order

Throws:

UnimplementedException - supportsReceiptSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsReceipttSearchOrder() is true.

getMessageSearchOrderRecord

MessageSearchOrderRecord getMessageSearchOrderRecord(Type messageRecordType)
                                                     throws OperationFailedException

Gets the message search order record corresponding to the given message record Type. Multiple retrievals return the same underlying object.

Parameters:

messageRecordType - a message record type

Returns:

the message search order record

Throws:

NullArgumentException - messageRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(messageRecordType) is false

Compliance:

mandatory - This method must be implemented.