Interface | osid.messaging.ReceiptAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session updates This session includes an | ||
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 | canUpdateReceipts | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Receipt modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getReceiptFormForUpdate | ||
Description |
Gets the receipt form for updating an existing receipt. A new receipt form should be requested for each update transaction. | ||
Parameters | osid.id.Id | receiptId | the Id of the Message |
Return | osid.messaging.ReceiptForm | the receipt form | |
Errors | NOT_FOUND | receiptId is not found | |
NULL_ARGUMENT | receiptId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateReceipt | ||
Description |
Updates an existing receipt. | ||
Parameters | osid.messaging.ReceiptForm | receiptForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | receiptForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | receiptForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | receiptForm did not originate from
getReceiptFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. |