OSID Specifications
messaging package
Version 3.1.0
messaging package
Version 3.1.0
| Interface | osid.messaging.MessageSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Used By | osid.messaging.MessageSearchSession | ||
osid.messaging.MessageSmartMailboxSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderBySubjectLine | ||
| Description |
Specifies a preference for ordering messages by subject line. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByText | ||
| Description |
Specifies a preference for ordering messages by text. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySent | ||
| Description |
Specifies a preference for ordering messages by sent. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySentTime | ||
| Description |
Specifies a preference for ordering messages by the sent time. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySender | ||
| Description |
Specifies a preference for ordering messages by sender. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSenderSearchOrder | ||
| Description |
Tests if a resource order is available. | ||
| Return | boolean | true if a resource order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSenderSearchOrder | ||
| Description |
Gets the resource order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsSenderSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsSenderSearchOrder() is true. | |
| Method | orderBySendingAgent | ||
| Description |
Specifies a preference for ordering messages by sending agent. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSendingAgentSearchOrder | ||
| Description |
Tests if an agent order is available. | ||
| Return | boolean | true if an agent order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSendingAgentSearchOrder | ||
| Description |
Gets the sending agent order. | ||
| Return | osid.authentication.AgentSearchOrder | the agent search order | |
| Errors | UNIMPLEMENTED | supportsSendingAgentSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsSendingAgentSearchOrder() is true. | |
| Method | orderByReceivedTime | ||
| Description |
Specifies a preference for ordering messages by the sent time. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDeliveryTime | ||
| Description |
Specifies a preference for ordering messages by the delivery time. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByReceipt | ||
| Description |
Specifies a preference for ordering messages by receipt. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsReceiptSearchOrder | ||
| Description |
Tests if a receipt order is available. | ||
| Return | boolean | true if a receipt order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getReceiptSearchOrder | ||
| Description |
Gets the receipt order. | ||
| Return | osid.messaging.ReceiptSearchOrder | the receipt search order | |
| Errors | UNIMPLEMENTED | supportsReceiptSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsReceipttSearchOrder() is true. | |
| Method | getMessageSearchOrderRecord | ||
| Description |
Gets the message search order record corresponding to
the given message record | ||
| Parameters | osid.type.Type | messageRecordType | a message record type |
| Return | osid.messaging.records.MessageSearchOrderRecord | the message search order record | |
| Errors | NULL_ARGUMENT | messageRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(messageRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |