OSID Logo
OSID Specifications
authorization batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.batch.FunctionBatchAdminSession
Implementsosid.authorization.FunctionAdminSession
Description

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.

MethodgetFunctionFormsForCreate
Description

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

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]functionRecordTypesarray of function record types to be included in each create operation or an empty list if none
Returnosid.authorization.batch.FunctionBatchFormListthe function forms
ErrorsNULL_ARGUMENT functionRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateFunctions
Description

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 .

Parametersosid.authorization.batch.FunctionBatchFormListfunctionFormsthe function forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT functionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFunctionFormsForUpdate
Description

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

Parametersosid.id.IdListfunctionIdsthe Ids of the Function
Returnosid.authorization.batch.FunctionBatchFormListthe function form
ErrorsNOT_FOUNDa functionId is not found
NULL_ARGUMENT functionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateFunctions
Description

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 .

Parametersosid.authorization.batch.FunctionBatchFormListfunctionFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT functionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllFunctions
Description

Deletes all Functions in this Vault .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteFunctions
Description

Deletes functions for the given Ids.

Parametersosid.id.IdListfunctionIdsthe Ids of the functions to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT functionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasFunctions
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.