Interface | osid.messaging.ReceiptLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving receipts to messages. This lookup session defines several views:
The methods Messages may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
Method | getMailboxId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Mailbox Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMailbox | ||
Description |
Gets the | ||
Return | osid.messaging.Mailbox | the Mailbox associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupReceipts | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeReceiptView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryReceiptView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedMailboxView | ||
Description |
Federates the view for methods in this session. A federated view will include receipts in mailboxes which are children of this mailbox in the mailbox hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedMailboxView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this mailbox only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getReceipt | ||
Description |
Gets the | ||
Parameters | osid.id.Id | receiptId | the Id of the Receipt to retrieve |
Return | osid.messaging.Receipt | the returned Receipt | |
Errors | NOT_FOUND | no Receipt found with the given Id | |
NULL_ARGUMENT | receiptId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReceiptsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | receiptIds | the list of Ids to retrieve |
Return | osid.messaging.ReceiptList | the returned Receipt list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | receiptIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReceiptsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | receiptGenusType | a receipt genus type |
Return | osid.messaging.ReceiptList | the returned Receipts list | |
Errors | NULL_ARGUMENT | receiptGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReceiptsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | receiptGenusType | a receipt genus type |
Return | osid.messaging.ReceiptList | the returned Receipts list | |
Errors | NULL_ARGUMENT | receiptGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReceiptsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | receiptRecordType | a receipt record type |
Return | osid.messaging.ReceiptList | the returned Receipt list | |
Errors | NULL_ARGUMENT | receiptRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReceiptsForMessage | ||
Description |
Gets a | ||
Parameters | osid.id.Id | messageId | a message Id |
Return | osid.messaging.ReceiptList | the returned Receipt list | |
Errors | NULL_ARGUMENT | messageId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReceiptsForRecipient | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.messaging.ReceiptList | the returned Receipts | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReceiptsForMessageAndRecipient | ||
Description |
Gets a list of | ||
Parameters | osid.id.Id | messageId | a message Id |
osid.id.Id | resourceId | a resource Id | |
Return | osid.messaging.ReceiptList | the returned Receipt | |
Errors | NULL_ARGUMENT | messageId or recipientId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReceipts | ||
Description |
Gets all | ||
Return | osid.messaging.ReceiptList | the returned Receipt | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |