OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MessageSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderBySubjectLine
Description

Specifies a preference for ordering messages by subject line.

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

Specifies a preference for ordering messages by text.

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

Specifies a preference for ordering messages by sent.

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

Specifies a preference for ordering messages by the sent time.

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

Specifies a preference for ordering messages by sender.

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

Tests if a resource order is available.

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

Gets the resource order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsSenderSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsSenderSearchOrder() is true.
MethodorderBySendingAgent
Description

Specifies a preference for ordering messages by sending agent.

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

Tests if an agent order is available.

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

Gets the sending agent order.

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

Specifies a preference for ordering messages by the sent time.

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

Specifies a preference for ordering messages by the delivery time.

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

Specifies a preference for ordering messages by receipt.

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

Tests if a receipt order is available.

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

Gets the receipt order.

Returnosid.messaging.ReceiptSearchOrderthe receipt search order
ErrorsUNIMPLEMENTED supportsReceiptSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsReceipttSearchOrder() is true.
MethodgetMessageSearchOrderRecord
Description

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

Parametersosid.type.TypemessageRecordTypea message record type
Returnosid.messaging.records.MessageSearchOrderRecordthe message search order record
ErrorsNULL_ARGUMENT messageRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(messageRecordType) is false
CompliancemandatoryThis method must be implemented.