org.osid.messaging

Interface ReceiptSearchOrder

All Superinterfaces:

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

public interface ReceiptSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ReceiptSearchOrderRecord	getReceiptSearchOrderRecord(Type receiptRecordType) Gets the receipt search order record corresponding to the given receipt record Type.
AgentSearchOrder	getReceivingAgentSearchOrder() Gets the receiving agent order.
ResourceSearchOrder	getRecipientSearchOrder() Gets the recipient order.
void	orderByReceivedTime(SearchOrderStyle style) Specifies a preference for ordering messages by the received time.
void	orderByReceivingAgent(SearchOrderStyle style) Specifies a preference for ordering messages by receiving agent.
void	orderByRecipient(SearchOrderStyle style) Specifies a preference for ordering messages by recipient.
boolean	supportsReceivingAgentSearchOrder() Tests if an agent order is available.
boolean	supportsRecipientSearchOrder() Tests if a resource 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

orderByReceivedTime

void orderByReceivedTime(SearchOrderStyle style)

Specifies a preference for ordering messages by the received time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByReceivingAgent

void orderByReceivingAgent(SearchOrderStyle style)

Specifies a preference for ordering messages by receiving agent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsReceivingAgentSearchOrder

boolean supportsReceivingAgentSearchOrder()

Tests if an agent order is available.

Returns:

true if an agent order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getReceivingAgentSearchOrder

AgentSearchOrder getReceivingAgentSearchOrder()

Gets the receiving agent order.

Returns:

the agent search order

Throws:

UnimplementedException - supportsReceivingAgentSearchOrder() is false

Compliance:

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

orderByRecipient

void orderByRecipient(SearchOrderStyle style)

Specifies a preference for ordering messages by recipient.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRecipientSearchOrder

boolean supportsRecipientSearchOrder()

Tests if a resource order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRecipientSearchOrder

ResourceSearchOrder getRecipientSearchOrder()

Gets the recipient order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsRecipienttSearchOrder() is false

Compliance:

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

getReceiptSearchOrderRecord

ReceiptSearchOrderRecord getReceiptSearchOrderRecord(Type receiptRecordType)
                                                     throws OperationFailedException

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

Parameters:

receiptRecordType - a receipt record type

Returns:

the receipt search order record

Throws:

NullArgumentException - receiptRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(receiptRecordType) is false

Compliance:

mandatory - This method must be implemented.