OSID Logo
OSID Specifications
forum batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.batch.ForumBatchAdminSession
Implementsosid.forum.ForumAdminSession
Description

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

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

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

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

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

The delete operations delete Forums in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetForumFormsForCreate
Description

Gets the forum forms for creating a bunch of new forums.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]forumRecordTypesarray of forum record types to be included in each create operation or an empty list if none
Returnosid.forum.batch.ForumBatchFormListthe forum forms
ErrorsNULL_ARGUMENT forumRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateForums
Description

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

Parametersosid.forum.batch.ForumBatchFormListforumFormsthe forum forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT forumForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetForumFormsForUpdate
Description

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

Parametersosid.id.IdListforumIdsthe Ids of the Forum
Returnosid.forum.batch.ForumBatchFormListthe forum form
ErrorsNOT_FOUNDa forumId is not found
NULL_ARGUMENT forumIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateForums
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 BatchCreateResponse .

Parametersosid.forum.batch.ForumBatchFormListforumFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT forumForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllForums
Description

Deletes all Forums.

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

Deletes forums for the given Ids.

Parametersosid.id.IdListforumIdsthe Ids of the forums to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT forumIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasForums
Description

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