OSID Logo
OSID Specifications
forum batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.batch.ReplyBatchAdminSession
Implementsosid.forum.ReplyAdminSession
Description

This session creates, updates, and deletes Replies 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 Reply, a ReplyForm is requested using getReplyFormsForCreate() specifying the desired post and record Types or none if no record Types are needed. Each of the returned ReplyForms 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 ReplyForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ReplyForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Replies in bulk. To unmap a Reply from the current Forum, the ReplyForumAssignmentSession should be used. These delete operations attempt to remove the Reply itself thus removing it from all known Forum catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetReplyFormsForCreate
Description

Gets the reply forms for creating a bunch of new replies. A form is returned for each supplied post or reply.

Parametersosid.id.IdListpostIdsthe post or reply Ids
osid.type.Type[]replyRecordTypesarray of reply record types to be included in each create operation or an empty list if none
Returnosid.forum.batch.ReplyBatchFormListthe reply forms
ErrorsNOT_FOUNDa postId is not found
NULL_ARGUMENT postIds or replyRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateReplies
Description

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

Parametersosid.forum.batch.ReplyBatchFormListreplyFormsthe reply forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT replyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetReplyFormsForUpdate
Description

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

Parametersosid.id.IdListreplyIdsthe Ids of the Reply
Returnosid.forum.batch.ReplyBatchFormListthe reply form
ErrorsNOT_FOUNDa replyId is not found
NULL_ARGUMENT replyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateReplies
Description

Updates existing replies. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.forum.batch.ReplyBatchFormListreplyFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT replyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllReplies
Description

Deletes all Replies in this Forum .

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

Deletes replies for the given Ids.

Parametersosid.id.IdListreplyIdsthe Ids of the replies to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT replyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRepliesForPost
Description

Deletes replies for the given post.

Parametersosid.id.IdpostIdan Id of a post
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT postId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRepliesByPoster
Description

Deletes replies for the given poster.

Parametersosid.id.IdresourceIdan 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.
MethoddeleteChildReplies
Description

Deletes replies under the given reply.

Parametersosid.id.IdreplyIdan Id of a reply
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT replyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasReplies
Description

Adds an Id to a Reply for the purpose of creating compatibility. The primary Id of the Reply is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another reply, it is reassigned to the given reply 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.