org.osid.control.batch

Interface InputBatchAdminSession

All Superinterfaces:

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

public interface InputBatchAdminSession
extends InputAdminSession

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

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

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

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

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

The delete operations delete Inputs in bulk. To unmap an Input from the current System, the InputSystemAssignmentSession should be used. These delete operations attempt to remove the Input itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteInputs.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasInputs(AliasRequestList aliasRequests) Adds an Id to an Input for the purpose of creating compatibility.
CreateResponseList	createInputs(InputBatchFormList inputForms) Creates a new set of Inputs.
DeleteResponseList	deleteAllInputs() Deletes all Inputs in this System.
DeleteResponseList	deleteIneffectiveInputsByDate(DateTime date) Deletes inputs expired before the given date.
DeleteResponseList	deleteInputs(IdList inputIds) Deletes inputs for the given Ids.
DeleteResponseList	deleteInputsForController(Id controllerId) Deletes inputs for the given Controller.
DeleteResponseList	deleteInputsForDevice(Id deviceId) Deletes inputs for the given Device.
InputBatchFormList	getInputFormsForCreate(InputPeerList peers, Type[] inputRecordTypes) Gets the input forms for creating a bunch of new inputs.
InputBatchFormList	getInputFormsForUpdate(IdList inputIds) Gets the input forms for updating an existing set of inputs.
UpdateResponseList	updateInputs(InputBatchFormList inputForms) Updates existing inputs.

Methods inherited from interface org.osid.control.InputAdminSession

aliasInput, canCreateInputs, canCreateInputWithRecordTypes, canDeleteInputs, canManageInputAliases, canUpdateInputs, createInput, deleteInput, getInputFormForCreate, getInputFormForUpdate, getSystem, getSystemId, updateInput

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

getInputFormsForCreate

InputBatchFormList getInputFormsForCreate(InputPeerList peers,
                                        Type[] inputRecordTypes)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the input forms for creating a bunch of new inputs. A form is retrieved for each device and controller pair.

Parameters:

peers - list of device controller peers

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

Returns:

the input forms

Throws:

NotFoundException - a deviceId or controllerId is not found

NullArgumentException - peers or inputRecordTypes 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.

createInputs

CreateResponseList createInputs(InputBatchFormList inputForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

inputForms - the input forms

Returns:

the create responses

Throws:

NullArgumentException - inputForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputFormsForUpdate

InputBatchFormList getInputFormsForUpdate(IdList inputIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

inputIds - the Ids of the Input

Returns:

the input form

Throws:

NotFoundException - an inputId is not found

NullArgumentException - inputIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateInputs

UpdateResponseList updateInputs(InputBatchFormList inputForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

inputForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - inputForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllInputs

DeleteResponseList deleteAllInputs()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Inputs in this System.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteInputs

DeleteResponseList deleteInputs(IdList inputIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes inputs for the given Ids.

Parameters:

inputIds - the Ids of the inputs to delete

Returns:

the delete responses

Throws:

NullArgumentException - inputIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteInputsForDevice

DeleteResponseList deleteInputsForDevice(Id deviceId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes inputs for the given Device.

Parameters:

deviceId - a deviceId Id

Returns:

the delete responses

Throws:

NullArgumentException - deviceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteInputsForController

DeleteResponseList deleteInputsForController(Id controllerId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Deletes inputs for the given Controller.

Parameters:

controllerId - a controller Id

Returns:

the delete responses

Throws:

NullArgumentException - controllerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveInputsByDate

DeleteResponseList deleteIneffectiveInputsByDate(DateTime date)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes inputs expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasInputs

AliasResponseList aliasInputs(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

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