org.osid.offering.batch

Interface CatalogueBatchAdminSession

All Superinterfaces:

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

public interface CatalogueBatchAdminSession
extends CatalogueAdminSession

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

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

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

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

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

The delete operations delete Catalogues in bulk. To unmap a Catalogue from the current Calendar, the CatalogueCalendarAssignmentSession should be used. These delete operations attempt to remove the Catalogue itself thus removing it from all known Calendar catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasCatalogues(AliasRequestList aliasRequests) Adds an Id to a Catalogue for the purpose of creating compatibility.
CreateResponseList	createCatalogues(CatalogueBatchFormList catalogueForms) Creates a new set of Catalogues.
DeleteResponseList	deleteAllCatalogues() Deletes all Catalogues in this Calendar .
DeleteResponseList	deleteCatalogues(IdList catalogueIds) Deletes catalogues for the given Ids.
CatalogueBatchFormList	getCatalogueFormsForCreate(long number, Type[] catalogueRecordTypes) Gets the catalogue forms for creating a bunch of new catalogues.
CatalogueBatchFormList	getCatalogueFormsForUpdate(IdList catalogueIds) Gets the catalogue forms for updating an existing set of catalogues.
UpdateResponseList	updateCatalogues(CatalogueBatchFormList catalogueForms) Updates existing catalogues.

Methods inherited from interface org.osid.offering.CatalogueAdminSession

aliasCatalogue, canCreateCatalogues, canCreateCatalogueWithRecordTypes, canDeleteCatalogues, canManageCatalogueAliases, canUpdateCatalogues, createCatalogue, deleteCatalogue, getCatalogueFormForCreate, getCatalogueFormForUpdate, updateCatalogue

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

getCatalogueFormsForCreate

CatalogueBatchFormList getCatalogueFormsForCreate(long number,
                                                Type[] catalogueRecordTypes)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets the catalogue forms for creating a bunch of new catalogues.

Parameters:

number - the number of forms to retrieve

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

Returns:

the catalogue forms

Throws:

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

createCatalogues

CreateResponseList createCatalogues(CatalogueBatchFormList catalogueForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

catalogueForms - the catalogue forms

Returns:

the create responses

Throws:

NullArgumentException - catalogueForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogueFormsForUpdate

CatalogueBatchFormList getCatalogueFormsForUpdate(IdList catalogueIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

catalogueIds - the Ids of the Catalogue

Returns:

the catalogue form

Throws:

NotFoundException - a catalogueId is not found

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCatalogues

UpdateResponseList updateCatalogues(CatalogueBatchFormList catalogueForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

catalogueForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - catalogueForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllCatalogues

DeleteResponseList deleteAllCatalogues()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Catalogues in this Calendar .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCatalogues

DeleteResponseList deleteCatalogues(IdList catalogueIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes catalogues for the given Ids.

Parameters:

catalogueIds - the Ids of the catalogues to delete

Returns:

the delete responses

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasCatalogues

AliasResponseList aliasCatalogues(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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