Interface | osid.messaging.MessageAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete 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 | canCreateMessages | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Message creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateMessageWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | messageRecordTypes | array of message record types |
Return | boolean | true if Message creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | messageRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getMessageFormForCreate | ||
Description |
Gets the message form for creating new messages. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | messageRecordTypes | array of message record types |
Return | osid.messaging.MessageForm | the message form | |
Errors | NULL_ARGUMENT | messageRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createMessage | ||
Description |
Creates a new | ||
Parameters | osid.messaging.MessageForm | messageForm | the form for this Message |
Return | osid.messaging.Message | the new Message | |
Errors | ILLEGAL_STATE | messageForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | messageForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | messageForm did not originate from
getMessageFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateMessages | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Message modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMessageFormForUpdate | ||
Description |
Gets the message form for updating an existing message. A new message form should be requested for each update transaction. | ||
Parameters | osid.id.Id | messageId | the Id of the Message |
Return | osid.messaging.MessageForm | the message form | |
Errors | NOT_FOUND | messageId is not found | |
NULL_ARGUMENT | messageId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateMessage | ||
Description |
Updates an existing message. | ||
Parameters | osid.messaging.MessageForm | messageForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | messageForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | messageForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | messageForm did not originate from
getMessageFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteMessages | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Message deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteMessage | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | messageId | the Id of the Message to remove |
Errors | NOT_FOUND | messageId not found | |
NULL_ARGUMENT | messageId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageMessageAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Message aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasMessage | ||
Description |
Adds an | ||
Parameters | osid.id.Id | messageId | the Id of a Message |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | messageId not found | ||
NULL_ARGUMENT | aliasId or messageId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |