OSID Logo
OSID Specifications
forum batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.batch.PostBatchAdminSession
Implementsosid.forum.PostAdminSession
Description

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

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

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

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

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

The delete operations delete Posts in bulk. To unmap a Post from the current Forum, the PostForumAssignmentSession should be used. These delete operations attempt to remove the Post itself thus removing it from all known Forum catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetPostFormsForCreate
Description

Gets the post forms for creating a bunch of new posts.

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

Creates a new set of Posts. 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.PostBatchFormListpostFormsthe post forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT postForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPostFormsForUpdate
Description

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

Parametersosid.id.IdListpostIdsthe Ids of the Post
Returnosid.forum.batch.PostBatchFormListthe post form
ErrorsNOT_FOUNDa postId is not found
NULL_ARGUMENT postIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePosts
Description

Updates existing posts. 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.PostBatchFormListpostFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT postForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllPosts
Description

Deletes all Posts in this Forum .

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

Deletes posts for the given Ids.

Parametersosid.id.IdListpostIdsthe Ids of the posts to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT postIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeletePostsByPoster
Description

Deletes posts for the given resource.

Parametersosid.id.IdresourceIdthe Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasPosts
Description

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