Interface | osid.forum.batch.ReplyBatchAdminSession | ||
---|---|---|---|
Implements | osid.forum.ReplyAdminSession | ||
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 | getReplyFormsForCreate | ||
Description |
Gets the reply forms for creating a bunch of new replies. A form is returned for each supplied post or reply. | ||
Parameters | osid.id.IdList | postIds | the post or reply Ids |
osid.type.Type[] | replyRecordTypes | array of reply record types to be included in each create operation or an empty list if none | |
Return | osid.forum.batch.ReplyBatchFormList | the reply forms | |
Errors | NOT_FOUND | a postId is not found | |
NULL_ARGUMENT | postIds or replyRecordTypes 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 | createReplies | ||
Description |
Creates a new set of | ||
Parameters | osid.forum.batch.ReplyBatchFormList | replyForms | the reply forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | replyForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getReplyFormsForUpdate | ||
Description |
Gets the reply forms for updating an existing set of replies. A new reply form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | replyIds | the Ids of the Reply |
Return | osid.forum.batch.ReplyBatchFormList | the reply form | |
Errors | NOT_FOUND | a replyId is not found | |
NULL_ARGUMENT | replyIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateReplies | ||
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 | ||
Parameters | osid.forum.batch.ReplyBatchFormList | replyForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | replyForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllReplies | ||
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 | deleteReplies | ||
Description |
Deletes replies for the given | ||
Parameters | osid.id.IdList | replyIds | the Ids of the replies to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | replyIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRepliesForPost | ||
Description |
Deletes replies for the given post. | ||
Parameters | osid.id.Id | postId | an Id of a post |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | postId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRepliesByPoster | ||
Description |
Deletes replies for the given poster. | ||
Parameters | osid.id.Id | resourceId | an Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteChildReplies | ||
Description |
Deletes replies under the given reply. | ||
Parameters | osid.id.Id | replyId | an Id of a reply |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | replyId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasReplies | ||
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. |