org.osid.forum.batch

Interface ForumBatchAdminSession

All Superinterfaces:

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

public interface ForumBatchAdminSession
extends ForumAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasForums(AliasRequestList aliasRequests) Adds an Id to a Forum for the purpose of creating compatibility.
CreateResponseList	createForums(ForumBatchFormList forumForms) Creates a new set of Forums.
DeleteResponseList	deleteAllForums() Deletes all Forums.
DeleteResponseList	deleteForums(IdList forumIds) Deletes forums for the given Ids.
ForumBatchFormList	getForumFormsForCreate(long number, Type[] forumRecordTypes) Gets the forum forms for creating a bunch of new forums.
ForumBatchFormList	getForumFormsForUpdate(IdList forumIds) Gets the forum forms for updating an existing set of forums.
UpdateResponseList	updateForums(ForumBatchFormList forumForms) Updates existing forums.

Methods inherited from interface org.osid.forum.ForumAdminSession

aliasForum, canCreateForums, canCreateForumWithRecordTypes, canDeleteForums, canManageForumAliases, canUpdateForums, createForum, deleteForum, getForumFormForCreate, getForumFormForUpdate, updateForum

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

getForumFormsForCreate

ForumBatchFormList getForumFormsForCreate(long number,
                                        Type[] forumRecordTypes)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

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

Returns:

the forum forms

Throws:

NullArgumentException - forumRecordTypes 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.

createForums

CreateResponseList createForums(ForumBatchFormList forumForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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 .

Parameters:

forumForms - the forum forms

Returns:

the create responses

Throws:

NullArgumentException - forumForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getForumFormsForUpdate

ForumBatchFormList getForumFormsForUpdate(IdList forumIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

forumIds - the Ids of the Forum

Returns:

the forum form

Throws:

NotFoundException - a forumId is not found

NullArgumentException - forumIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateForums

UpdateResponseList updateForums(ForumBatchFormList forumForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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 .

Parameters:

forumForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - forumForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllForums

DeleteResponseList deleteAllForums()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Forums.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteForums

DeleteResponseList deleteForums(IdList forumIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes forums for the given Ids.

Parameters:

forumIds - the Ids of the forums to delete

Returns:

the delete responses

Throws:

NullArgumentException - forumIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasForums

AliasResponseList aliasForums(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

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.

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.