org.osid.commenting.batch

Interface CommentBatchAdminSession

All Superinterfaces:

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

public interface CommentBatchAdminSession
extends CommentAdminSession

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

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

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

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

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

The delete operations delete Comments in bulk. To unmap a Comment from the current Book, the CommentBookAssignmentSession should be used. These delete operations attempt to remove the Comment itself thus removing it from all known Book catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasComments(AliasRequestList aliasRequests) Adds an Id to a Comment for the purpose of creating compatibility.
CreateResponseList	createComments(CommentBatchFormList commentForms) Creates a new set of Comments.
DeleteResponseList	deleteAllComments() Deletes all Comments in this Book .
DeleteResponseList	deleteComments(IdList commentIds) Deletes comments for the given Ids.
DeleteResponseList	deleteCommentsForCommentor(Id commentorId) Deletes comments for the given commentor.
DeleteResponseList	deleteCommentsForReference(Id referenceId) Deletes comments for the given reference.
DeleteResponseList	deleteIneffectiveCommentsByDate(DateTime date) Deletes comments expired before the given date.
CommentBatchFormList	getCommentFormsForCreate(IdList referenceIds, Type[] commentRecordTypes) Gets the comment forms for creating a bunch of new comments.
CommentBatchFormList	getCommentFormsForUpdate(IdList commentIds) Gets the comment forms for updating an existing set of comments.
UpdateResponseList	updateComments(CommentBatchFormList commentForms) Updates existing comments.

Methods inherited from interface org.osid.commenting.CommentAdminSession

aliasComment, canCreateComments, canCreateCommentWithRecordTypes, canDeleteComments, canManageCommentAliases, canUpdateComments, createComment, deleteComment, getBook, getBookId, getCommentFormForCreate, getCommentFormForUpdate, updateComment

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

getCommentFormsForCreate

CommentBatchFormList getCommentFormsForCreate(IdList referenceIds,
                                            Type[] commentRecordTypes)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the comment forms for creating a bunch of new comments. A form is returned for each supplied reference.

Parameters:

referenceIds - the reference Ids

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

Returns:

the comment forms

Throws:

NotFoundException - a referenceId is not found

NullArgumentException - commentRecordTypes 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.

createComments

CreateResponseList createComments(CommentBatchFormList commentForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

commentForms - the comment forms

Returns:

the create responses

Throws:

NullArgumentException - commentForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommentFormsForUpdate

CommentBatchFormList getCommentFormsForUpdate(IdList commentIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

commentIds - the Ids of the Comment

Returns:

the comment form

Throws:

NotFoundException - a commentId is not found

NullArgumentException - commentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateComments

UpdateResponseList updateComments(CommentBatchFormList commentForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

commentForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - commentForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllComments

DeleteResponseList deleteAllComments()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Comments in this Book .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteComments

DeleteResponseList deleteComments(IdList commentIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes comments for the given Ids.

Parameters:

commentIds - the Ids of the comments to delete

Returns:

the delete responses

Throws:

NullArgumentException - commentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCommentsForReference

DeleteResponseList deleteCommentsForReference(Id referenceId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Deletes comments for the given reference.

Parameters:

referenceId - the Id of a reference

Returns:

the delete responses

Throws:

NullArgumentException - referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCommentsForCommentor

DeleteResponseList deleteCommentsForCommentor(Id commentorId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Deletes comments for the given commentor.

Parameters:

commentorId - the Id of a commentor

Returns:

the delete responses

Throws:

NullArgumentException - commentorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveCommentsByDate

DeleteResponseList deleteIneffectiveCommentsByDate(DateTime date)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Deletes comments expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasComments

AliasResponseList aliasComments(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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