org.osid.control.batch

Interface SystemBatchAdminSession

All Superinterfaces:

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

public interface SystemBatchAdminSession
extends SystemAdminSession

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

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

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

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

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

The delete operations delete Systems in bulk. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasSystems(AliasRequestList aliasRequests) Adds an Id to a System for the purpose of creating compatibility.
CreateResponseList	createSystems(SystemBatchFormList systemForms) Creates a new set of Systems.
DeleteResponseList	deleteAllSystems() Deletes all Systems.
DeleteResponseList	deleteSystems(IdList systemIds) Deletes systems for the given Ids.
SystemBatchFormList	getSystemFormsForCreate(long number, Type[] systemRecordTypes) Gets the system forms for creating a bunch of new systems.
SystemBatchFormList	getSystemFormsForUpdate(IdList systemIds) Gets the system forms for updating an existing set of systems.
UpdateResponseList	updateSystems(SystemBatchFormList systemForms) Updates existing system.

Methods inherited from interface org.osid.control.SystemAdminSession

aliasSystem, canCreateSystems, canCreateSystemWithRecordTypes, canDeleteSystems, canManageSystemAliases, canUpdateSystems, createSystem, deleteSystem, getSystemFormForCreate, getSystemFormForUpdate, updateSystem

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

getSystemFormsForCreate

SystemBatchFormList getSystemFormsForCreate(long number,
                                          Type[] systemRecordTypes)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets the system forms for creating a bunch of new systems.

Parameters:

number - the number of forms to retrieve

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

Returns:

the system forms

Throws:

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

createSystems

CreateResponseList createSystems(SystemBatchFormList systemForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

systemForms - the system forms

Returns:

the create responses

Throws:

NullArgumentException - systemForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemFormsForUpdate

SystemBatchFormList getSystemFormsForUpdate(IdList systemIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

systemIds - the Ids of the Systems

Returns:

the system form

Throws:

NotFoundException - a systemId is not found

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateSystems

UpdateResponseList updateSystems(SystemBatchFormList systemForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

systemForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - systemForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllSystems

DeleteResponseList deleteAllSystems()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Systems.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSystems

DeleteResponseList deleteSystems(IdList systemIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes systems for the given Ids.

Parameters:

systemIds - the Ids of the systems to delete

Returns:

the delete responses

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasSystems

AliasResponseList aliasSystems(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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