| Interface | osid.commenting.batch.CommentBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.commenting.CommentAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create a   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getCommentFormsForCreate | ||
| Description | 
                     Gets the comment forms for creating a bunch of new comments. A form is returned for each supplied reference.  | ||
| Parameters | osid.id.IdList | referenceIds | the reference  Ids   | 
osid.type.Type[] | commentRecordTypes | array of comment record types to be included in each create operation or an empty list if none | |
| Return | osid.commenting.batch.CommentBatchFormList | the comment forms | |
| Errors | NOT_FOUND | a  referenceId  is not found  |                 |
| NULL_ARGUMENT |  commentRecordTypes  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | unable to request forms with given record types | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | createComments | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.commenting.batch.CommentBatchFormList | commentForms | the comment forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  commentForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommentFormsForUpdate | ||
| Description | 
                     Gets the comment forms for updating an existing set of comments. A new comment form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | commentIds | the  Ids  of the  Comment   | 
| Return | osid.commenting.batch.CommentBatchFormList | the comment form | |
| Errors | NOT_FOUND | a  commentId  is not found  |                 |
| NULL_ARGUMENT |  commentIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateComments | ||
| 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   | ||
| Parameters | osid.commenting.batch.CommentBatchFormList | commentForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  commentForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllComments | ||
| Description | 
                     Deletes all   | ||
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteComments | ||
| Description | 
                     Deletes comments for the given   | ||
| Parameters | osid.id.IdList | commentIds | the  Ids  of the comments to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  commentIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteCommentsForReference | ||
| Description | 
                     Deletes comments for the given reference.  | ||
| Parameters | osid.id.Id | referenceId | the  Id  of a reference  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  referenceId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteCommentsForCommentor | ||
| Description | 
                     Deletes comments for the given commentor.  | ||
| Parameters | osid.id.Id | commentorId | the  Id  of a commentor  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  commentorId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveCommentsByDate | ||
| Description | 
                     Deletes comments expired before the given date.  | ||
| Parameters | osid.calendaring.DateTime | date | a date | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  date  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasComments | ||
| Description | 
                     Adds an   | ||
| Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests | 
| Return | osid.transaction.batch.AliasResponseList | the alias responses | |
| Errors | NULL_ARGUMENT |  aliasRequests  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |