OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.ReceiptSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByReceivedTime
Description

Specifies a preference for ordering messages by the received time.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByReceivingAgent
Description

Specifies a preference for ordering messages by receiving agent.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsReceivingAgentSearchOrder
Description

Tests if an agent order is available.

Returnboolean true if an agent order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetReceivingAgentSearchOrder
Description

Gets the receiving agent order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsUNIMPLEMENTED supportsReceivingAgentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsReceivingAgentSearchOrder() is true.
MethodorderByRecipient
Description

Specifies a preference for ordering messages by recipient.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipientSearchOrder
Description

Tests if a resource order is available.

Returnboolean true if a resource order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRecipientSearchOrder
Description

Gets the recipient order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsRecipienttSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsRecipientSearchOrder() is true.
MethodgetReceiptSearchOrderRecord
Description

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

Parametersosid.type.TypereceiptRecordTypea receipt record type
Returnosid.messaging.records.ReceiptSearchOrderRecordthe receipt search order record
ErrorsNULL_ARGUMENT receiptRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(receiptRecordType) is false
CompliancemandatoryThis method must be implemented.