org.osid.billing.batch

Interface CategoryBatchAdminSession

All Superinterfaces:

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

public interface CategoryBatchAdminSession
extends CategoryAdminSession

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

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

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

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

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

The delete operations delete Categories in bulk. To unmap a Category from the current Business, the CategoryBusinessAssignmentSession should be used. These delete operations attempt to remove the Category itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasCategories(AliasRequestList aliasRequests) Adds an Id to a Category for the purpose of creating compatibility.
CreateResponseList	createCategories(CategoryBatchFormList categoryForms) Creates a new set of Categories.
DeleteResponseList	deleteAllCategories() Deletes all Categories in this Business .
DeleteResponseList	deleteCategories(IdList categoryIds) Deletes categories for the given Ids.
CategoryBatchFormList	getCategoryFormsForCreate(long number, Type[] categoryRecordTypes) Gets the categoryforms for creating a bunch of new categories.
CategoryBatchFormList	getCategoryFormsForUpdate(IdList categoryIds) Gets the category forms for updating an existing set of categories.
UpdateResponseList	updateCategories(CategoryBatchFormList categoryForms) Updates existing categories.

Methods inherited from interface org.osid.billing.CategoryAdminSession

aliasCategory, canCreateCategories, canCreateCategoryWithRecordTypes, canDeleteCategories, canManageCategoryAliases, canUpdateCategories, createCategory, deleteCategory, getBusiness, getBusinessId, getCategoryFormForCreate, getCategoryFormForUpdate, updateCategory

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

getCategoryFormsForCreate

CategoryBatchFormList getCategoryFormsForCreate(long number,
                                              Type[] categoryRecordTypes)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets the categoryforms for creating a bunch of new categories.

Parameters:

number - the number of forms to retrieve

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

Returns:

the category forms

Throws:

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

createCategories

CreateResponseList createCategories(CategoryBatchFormList categoryForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

categoryForms - the category forms

Returns:

the create responses

Throws:

NullArgumentException - categoryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCategoryFormsForUpdate

CategoryBatchFormList getCategoryFormsForUpdate(IdList categoryIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the category forms for updating an existing set of categories. A new categoryform should be requested for each update transaction.

Parameters:

categoryIds - the Ids of the Category

Returns:

the category form

Throws:

NotFoundException - a categoryId is not found

NullArgumentException - categoryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCategories

UpdateResponseList updateCategories(CategoryBatchFormList categoryForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Updates existing categories. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

categoryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - categoryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllCategories

DeleteResponseList deleteAllCategories()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Categories in this Business .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCategories

DeleteResponseList deleteCategories(IdList categoryIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes categories for the given Ids.

Parameters:

categoryIds - the Ids of the categories to delete

Returns:

the delete responses

Throws:

NullArgumentException - categoryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasCategories

AliasResponseList aliasCategories(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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