Interface | osid.forum.batch.ForumBatchAdminSession | ||
---|---|---|---|
Implements | osid.forum.ForumAdminSession | ||
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 | getForumFormsForCreate | ||
Description |
Gets the forum forms for creating a bunch of new forums. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | forumRecordTypes | array of forum record types to be included in each create operation or an empty list if none | |
Return | osid.forum.batch.ForumBatchFormList | the forum forms | |
Errors | NULL_ARGUMENT | forumRecordTypes 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 | createForums | ||
Description |
Creates a new set of | ||
Parameters | osid.forum.batch.ForumBatchFormList | forumForms | the forum forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | forumForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getForumFormsForUpdate | ||
Description |
Gets the forum forms for updating an existing set of forums. A new forum form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | forumIds | the Ids of the Forum |
Return | osid.forum.batch.ForumBatchFormList | the forum form | |
Errors | NOT_FOUND | a forumId is not found | |
NULL_ARGUMENT | forumIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateForums | ||
Description |
Updates existing forums. 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.ForumBatchFormList | forumForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | forumForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllForums | ||
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 | deleteForums | ||
Description |
Deletes forums for the given | ||
Parameters | osid.id.IdList | forumIds | the Ids of the forums to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | forumIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasForums | ||
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. |