org.osid.offering.batch

Interface CanonicalUnitBatchAdminSession

All Superinterfaces:

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

public interface CanonicalUnitBatchAdminSession
extends CanonicalUnitAdminSession

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

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

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

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasCanonicalUnits(AliasRequestList aliasRequests) Adds an Id to a CanonicalUnit for the purpose of creating compatibility.
CreateResponseList	createCanonicalUnits(CanonicalUnitBatchFormList canonicalUnitForms) Creates a new set of CanonicalUnits.
DeleteResponseList	deleteAllCanonicalUnits() Deletes all CanonicalUnits in this Catalogue .
DeleteResponseList	deleteCanonicalUnits(IdList canonicalUnitIds) Deletes canonicalUnits for the given Ids.
CanonicalUnitBatchFormList	getCanonicalUnitFormsForCreate(long number, Type[] canonicalUnitRecordTypes) Gets the canonical unit forms for creating a bunch of new canonical units.
CanonicalUnitBatchFormList	getCanonicalUnitFormsForUpdate(IdList canonicalUnitIds) Gets the canonical unit forms for updating an existing set of canonicalUnits.
UpdateResponseList	updateCanonicalUnits(CanonicalUnitBatchFormList canonicalUnitForms) Updates existing canonical units.

Methods inherited from interface org.osid.offering.CanonicalUnitAdminSession

aliasCanonicalUnit, canCreateCanonicalUnits, canCreateCanonicalUnitWithRecordTypes, canDeleteCanonicalUnits, canManageCanonicalUnitAliases, canUpdateCanonicalUnits, createCanonicalUnit, deleteCanonicalUnit, getCanonicalUnitFormForCreate, getCanonicalUnitFormForUpdate, getCatalogue, getCatalogueId, updateCanonicalUnit

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

getCanonicalUnitFormsForCreate

CanonicalUnitBatchFormList getCanonicalUnitFormsForCreate(long number,
                                                        Type[] canonicalUnitRecordTypes)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets the canonical unit forms for creating a bunch of new canonical units.

Parameters:

number - the number of forms to retrieve

canonicalUnitRecordTypes - array of canonical unit record types to be included in each create operation or an empty list if none

Returns:

the canonical unit forms

Throws:

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

createCanonicalUnits

CreateResponseList createCanonicalUnits(CanonicalUnitBatchFormList canonicalUnitForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

canonicalUnitForms - the canonical unit forms

Returns:

the create responses

Throws:

NullArgumentException - canonicalUnitForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitFormsForUpdate

CanonicalUnitBatchFormList getCanonicalUnitFormsForUpdate(IdList canonicalUnitIds)
                                                          throws NotFoundException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

Gets the canonical unit forms for updating an existing set of canonicalUnits. A new canonical unit form should be requested for each update transaction.

Parameters:

canonicalUnitIds - the Ids of the CanonicalUnit

Returns:

the canonical unit form

Throws:

NotFoundException - a canonicalUnitId is not found

NullArgumentException - canonicalUnitIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCanonicalUnits

UpdateResponseList updateCanonicalUnits(CanonicalUnitBatchFormList canonicalUnitForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

canonicalUnitForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - canonicalUnitForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllCanonicalUnits

DeleteResponseList deleteAllCanonicalUnits()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes all CanonicalUnits in this Catalogue .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCanonicalUnits

DeleteResponseList deleteCanonicalUnits(IdList canonicalUnitIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes canonicalUnits for the given Ids.

Parameters:

canonicalUnitIds - the Ids of the canonical units to delete

Returns:

the delete responses

Throws:

NullArgumentException - canonicalUnitIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasCanonicalUnits

AliasResponseList aliasCanonicalUnits(AliasRequestList aliasRequests)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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