OSID Logo
OSID Specifications
commenting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.batch.CommentBatchAdminSession
Implementsosid.commenting.CommentAdminSession
Description

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.

MethodgetCommentFormsForCreate
Description

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

Parametersosid.id.IdListreferenceIdsthe reference Ids
osid.type.Type[]commentRecordTypesarray of comment record types to be included in each create operation or an empty list if none
Returnosid.commenting.batch.CommentBatchFormListthe comment forms
ErrorsNOT_FOUNDa referenceId is not found
NULL_ARGUMENT commentRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateComments
Description

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 .

Parametersosid.commenting.batch.CommentBatchFormListcommentFormsthe comment forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT commentForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommentFormsForUpdate
Description

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

Parametersosid.id.IdListcommentIdsthe Ids of the Comment
Returnosid.commenting.batch.CommentBatchFormListthe comment form
ErrorsNOT_FOUNDa commentId is not found
NULL_ARGUMENT commentIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateComments
Description

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 .

Parametersosid.commenting.batch.CommentBatchFormListcommentFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT commentForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllComments
Description

Deletes all Comments in this Book .

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

Deletes comments for the given Ids.

Parametersosid.id.IdListcommentIdsthe Ids of the comments to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT commentIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCommentsForReference
Description

Deletes comments for the given reference.

Parametersosid.id.IdreferenceIdthe Id of a reference
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCommentsForCommentor
Description

Deletes comments for the given commentor.

Parametersosid.id.IdcommentorIdthe Id of a commentor
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT commentorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveCommentsByDate
Description

Deletes comments expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasComments
Description

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.

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.