org.osid.authorization.batch

Interface FunctionBatchAdminSession

All Superinterfaces:

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

public interface FunctionBatchAdminSession
extends FunctionAdminSession

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

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

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

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

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

The delete operations delete Functions in bulk. To unmap a Function from the current Vault, the FunctionVaultAssignmentSession should be used. These delete operations attempt to remove the Function itself thus removing it from all known Vault catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasFunctions(AliasRequestList aliasRequests) Adds an Id to a Function for the purpose of creating compatibility.
CreateResponseList	createFunctions(FunctionBatchFormList functionForms) Creates a new set of Functions.
DeleteResponseList	deleteAllFunctions() Deletes all Functions in this Vault .
DeleteResponseList	deleteFunctions(IdList functionIds) Deletes functions for the given Ids.
FunctionBatchFormList	getFunctionFormsForCreate(long number, Type[] functionRecordTypes) Gets the function forms for creating a bunch of new functions.
FunctionBatchFormList	getFunctionFormsForUpdate(IdList functionIds) Gets the function forms for updating an existing set of functions.
UpdateResponseList	updateFunctions(FunctionBatchFormList functionForms) Updates existing functions.

Methods inherited from interface org.osid.authorization.FunctionAdminSession

aliasFunction, canCreateFunctions, canCreateFunctionWithRecordTypes, canDeleteFunctions, canManageFunctionAliases, canUpdateFunctions, createFunction, deleteFunction, getFunctionFormForCreate, getFunctionFormForUpdate, getVault, getVaultId, updateFunction

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

getFunctionFormsForCreate

FunctionBatchFormList getFunctionFormsForCreate(long number,
                                              Type[] functionRecordTypes)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets the function forms for creating a bunch of new functions.

Parameters:

number - the number of forms to retrieve

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

Returns:

the function forms

Throws:

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

createFunctions

CreateResponseList createFunctions(FunctionBatchFormList functionForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

functionForms - the function forms

Returns:

the create responses

Throws:

NullArgumentException - functionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFunctionFormsForUpdate

FunctionBatchFormList getFunctionFormsForUpdate(IdList functionIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

functionIds - the Ids of the Function

Returns:

the function form

Throws:

NotFoundException - a functionId is not found

NullArgumentException - functionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateFunctions

UpdateResponseList updateFunctions(FunctionBatchFormList functionForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

functionForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - functionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllFunctions

DeleteResponseList deleteAllFunctions()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Functions in this Vault .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteFunctions

DeleteResponseList deleteFunctions(IdList functionIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes functions for the given Ids.

Parameters:

functionIds - the Ids of the functions to delete

Returns:

the delete responses

Throws:

NullArgumentException - functionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasFunctions

AliasResponseList aliasFunctions(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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