OSID Logo
OSID Specifications
messaging batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.batch.MessageBatchAdminSession
Implementsosid.messaging.MessageAdminSession
Description

This session creates, updates, and deletes Messages in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Message, a MessageForm is requested using getMessageFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned MessageForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a MessageForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each MessageForm corresponds to an attempted transaction.

The MessageForms returned from getMessageFormsForCreate() may be linked to the originating request through the peer Ids of the MessageForm. In the case where there may be duplicates, any MessageForm of the same peer Ids may be used for a create operation.

Once a batch of MessageForms are submitted for create, a CreateResponse is returned for each MessageForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createMessages(), errors specific to an individual MessageForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating MessageForm through the MessageForm Id .

For updates, MessageForms are requested to the Message Id that is to be updated using getMessageFormsForUpdate() where the reference Id in the MessageForm may be used to link the request. Similarly, the MessageForm has metadata about the data that can be updated and it can perform validation before submitting the update. The MessageForm can only be used once for a successful update and cannot be reused.

Once a batch of MessageForms are submitted for update, an UpdateResponse is returned for each MessageForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateMessages(), errors specific to an individual MessageForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating MessageForm through the MessageForm Id.

The delete operations delete Messages in bulk. To unmap a Message from the current Mailbox, the MessageMailboxAssignmentSession should be used. These delete operations attempt to remove the Message itself thus removing it from all known Mailbox catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetMessageFormsForCreate
Description

Gets the message forms for creating a bunch of new messages.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]messageRecordTypesarray of message record types to be included in each create operation or an empty list if none
Returnosid.messaging.batch.MessageBatchFormListthe message forms
ErrorsNULL_ARGUMENT messageRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateMessages
Description

Creates a new set of Messages. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.messaging.batch.MessageBatchFormListmessageFormsthe message forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT messageForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMessageFormsForUpdate
Description

Gets the message forms for updating an existing set of messages. A new message form should be requested for each update transaction.

Parametersosid.id.IdListmessageIdsthe Ids of the Message
Returnosid.messaging.batch.MessageBatchFormListthe message form
ErrorsNOT_FOUNDa messageId is not found
NULL_ARGUMENT messageIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateMessages
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 BatchCreateResponse .

Parametersosid.messaging.batch.MessageBatchFormListmessageFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT messageForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllMessages
Description

Deletes all Messages in this Mailbox .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteMessagesBySender
Description

Deletes messages for the given sender resource.

Parametersosid.id.IdresourceIdthe Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteMessagesByDate
Description

Deletes messages received between the given date range inclusive.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasMessages
Description

Adds an Id to a Message for the purpose of creating compatibility. The primary Id of the Message is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another message, it is reassigned to the given message Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.