org.osid.forum.batch

Interface ReplyBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, ReplyAdminSession

public interface ReplyBatchAdminSession
extends ReplyAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasReplies(AliasRequestList aliasRequests) Adds an Id to a Reply for the purpose of creating compatibility.
CreateResponseList	createReplies(ReplyBatchFormList replyForms) Creates a new set of Replies.
DeleteResponseList	deleteAllReplies() Deletes all Replies in this Forum .
DeleteResponseList	deleteChildReplies(Id replyId) Deletes replies under the given reply.
DeleteResponseList	deleteReplies(IdList replyIds) Deletes replies for the given Ids.
DeleteResponseList	deleteRepliesByPoster(Id resourceId) Deletes replies for the given poster.
DeleteResponseList	deleteRepliesForPost(Id postId) Deletes replies for the given post.
ReplyBatchFormList	getReplyFormsForCreate(IdList postIds, Type[] replyRecordTypes) Gets the reply forms for creating a bunch of new replies.
ReplyBatchFormList	getReplyFormsForUpdate(IdList replyIds) Gets the reply forms for updating an existing set of replies.
UpdateResponseList	updateReplies(ReplyBatchFormList replyForms) Updates existing replies.

Methods inherited from interface org.osid.forum.ReplyAdminSession

aliasReply, canCreateReplies, canCreateReplyWithRecordTypes, canDeleteReplies, canManageReplyAliases, canUpdateReplies, createReply, deleteReply, getForum, getForumId, getReplyFormForCreateToPost, getReplyFormForCreateToReply, getReplyFormForUpdate, updateReply

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getReplyFormsForCreate

ReplyBatchFormList getReplyFormsForCreate(IdList postIds,
                                        Type[] replyRecordTypes)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

postIds - the post or reply Ids

replyRecordTypes - array of reply record types to be included in each create operation or an empty list if none

Returns:

the reply forms

Throws:

NotFoundException - a postId is not found

NullArgumentException - postIds or replyRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createReplies

CreateResponseList createReplies(ReplyBatchFormList replyForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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 .

Parameters:

replyForms - the reply forms

Returns:

the create responses

Throws:

NullArgumentException - replyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getReplyFormsForUpdate

ReplyBatchFormList getReplyFormsForUpdate(IdList replyIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

replyIds - the Ids of the Reply

Returns:

the reply form

Throws:

NotFoundException - a replyId is not found

NullArgumentException - replyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateReplies

UpdateResponseList updateReplies(ReplyBatchFormList replyForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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 .

Parameters:

replyForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - replyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllReplies

DeleteResponseList deleteAllReplies()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Replies in this Forum .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteReplies

DeleteResponseList deleteReplies(IdList replyIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes replies for the given Ids.

Parameters:

replyIds - the Ids of the replies to delete

Returns:

the delete responses

Throws:

NullArgumentException - replyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRepliesForPost

DeleteResponseList deleteRepliesForPost(Id postId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes replies for the given post.

Parameters:

postId - an Id of a post

Returns:

the delete responses

Throws:

NullArgumentException - postId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRepliesByPoster

DeleteResponseList deleteRepliesByPoster(Id resourceId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes replies for the given poster.

Parameters:

resourceId - an Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteChildReplies

DeleteResponseList deleteChildReplies(Id replyId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes replies under the given reply.

Parameters:

replyId - an Id of a reply

Returns:

the delete responses

Throws:

NullArgumentException - replyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasReplies

AliasResponseList aliasReplies(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.