org.osid.forum.batch

Interface PostBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PostAdminSession

public interface PostBatchAdminSession
extends PostAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPosts(AliasRequestList aliasRequests) Adds an Id to a Post for the purpose of creating compatibility.
CreateResponseList	createPosts(PostBatchFormList postForms) Creates a new set of Posts.
DeleteResponseList	deleteAllPosts() Deletes all Posts in this Forum .
DeleteResponseList	deletePosts(IdList postIds) Deletes posts for the given Ids.
DeleteResponseList	deletePostsByPoster(Id resourceId) Deletes posts for the given resource.
PostBatchFormList	getPostFormsForCreate(long number, Type[] postRecordTypes) Gets the post forms for creating a bunch of new posts.
PostBatchFormList	getPostFormsForUpdate(IdList postIds) Gets the post forms for updating an existing set of posts.
UpdateResponseList	updatePosts(PostBatchFormList postForms) Updates existing posts.

Methods inherited from interface org.osid.forum.PostAdminSession

aliasPost, canCreatePosts, canCreatePostWithRecordTypes, canDeletePosts, canManagePostAliases, canUpdatePosts, createPost, deletePost, getForum, getForumId, getPostFormForCreate, getPostFormForUpdate, updatePost

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPostFormsForCreate

PostBatchFormList getPostFormsForCreate(long number,
                                      Type[] postRecordTypes)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

postRecordTypes - array of post record types to be included in each create operation or an empty list if none

Returns:

the post forms

Throws:

NullArgumentException - postRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createPosts

CreateResponseList createPosts(PostBatchFormList postForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

postForms - the post forms

Returns:

the create responses

Throws:

NullArgumentException - postForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostFormsForUpdate

PostBatchFormList getPostFormsForUpdate(IdList postIds)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

postIds - the Ids of the Post

Returns:

the post form

Throws:

NotFoundException - a postId is not found

NullArgumentException - postIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePosts

UpdateResponseList updatePosts(PostBatchFormList postForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

postForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - postForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPosts

DeleteResponseList deleteAllPosts()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes all Posts in this Forum .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePosts

DeleteResponseList deletePosts(IdList postIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Deletes posts for the given Ids.

Parameters:

postIds - the Ids of the posts to delete

Returns:

the delete responses

Throws:

NullArgumentException - postIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePostsByPoster

DeleteResponseList deletePostsByPoster(Id resourceId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes posts for the given resource.

Parameters:

resourceId - the Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPosts

AliasResponseList aliasPosts(AliasRequestList aliasRequests)
                             throws OperationFailedException,
                                    PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.