| Interface | osid.messaging.batch.MessageBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.messaging.MessageAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create a   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getMessageFormsForCreate | ||
| Description | 
                     Gets the message forms for creating a bunch of new messages.  | ||
| Parameters | cardinal | number | the number of forms to retrieve | 
osid.type.Type[] | messageRecordTypes | array of message record types to be included in each create operation or an empty list if none | |
| Return | osid.messaging.batch.MessageBatchFormList | the message forms | |
| Errors | NULL_ARGUMENT |  messageRecordTypes  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | unable to request forms with given record types | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | createMessages | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.messaging.batch.MessageBatchFormList | messageForms | the message forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  messageForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getMessageFormsForUpdate | ||
| Description | 
                     Gets the message forms for updating an existing set of messages. A new message form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | messageIds | the  Ids  of the  Message   | 
| Return | osid.messaging.batch.MessageBatchFormList | the message form | |
| Errors | NOT_FOUND | a  messageId  is not found  |                 |
| NULL_ARGUMENT |  messageIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateMessages | ||
| Description | 
                     Updates existing messages. This method returns an error 
                    if the entire operation fails. Otherwise, the status of an 
                    individual update operation is indicated in the   | ||
| Parameters | osid.messaging.batch.MessageBatchFormList | messageForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  messageForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllMessages | ||
| Description | 
                     Deletes all   | ||
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteMessagesBySender | ||
| Description | 
                     Deletes messages for the given sender resource.  | ||
| Parameters | osid.id.Id | resourceId | the  Id  of a resource  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  resourceId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteMessagesByDate | ||
| Description | 
                     Deletes messages received between the given date range inclusive.  | ||
| Parameters | osid.calendaring.DateTime | from | start of date range | 
osid.calendaring.DateTime | to | end of date range | |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | INVALID_ARGUMENT |  from  is greater than  to   |                 |
| NULL_ARGUMENT |  from  or  to  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasMessages | ||
| Description | 
                     Adds an   | ||
| Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests | 
| Return | osid.transaction.batch.AliasResponseList | the alias responses | |
| Errors | NULL_ARGUMENT |  aliasRequests  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |