public interface ControllerBatchAdminSession extends ControllerAdminSession
This session creates, updates, and deletes Controllers
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
Controller,
a ControllerForm
is requested using
getControllerFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed.
Each of the returned ControllerForms
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 ControllerForm
is submiited to a create operation, it cannot be reused with another
create operation unless the first operation was unsuccessful. Each
ControllerForm
corresponds to an attempted transaction.
The ControllerForms
returned from
getControllerFormsForCreate()
may be linked to the originating
request through the peer Ids
of the ControllerForm.
In the case where there may be duplicates, any
ControllerForm
of the same peer Ids
may be used for
a create operation.
Once a batch of ControllerForm
are submitted for
create, a CreateController
is returned for each
ControllerForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createControllers(),
errors specific to an individual
ControllerForm
are indicated in the corresponding
CreateController.
CreateControllers
may be linked
to the originating ControllerForm
through the
ControllerForm
Id
.
For updates, ControllerForms
are requested to the
Controller
Id
that is to be updated using
getControllerFormsForUpdate()
where the reference Id
in the ControllerForm
may be used to link the
request. Similarly, the ControllerForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The ControllerForm
can only be used
once for a successful update and cannot be reused.
Once a batch of ControllerForms
are submitted for
update, an UpdateController
is returned for each
ControllerForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateControllers(),
errors specific to an individual
ControllerForm
are indicated in the corresponding
UpdateController.
UpdateControllers
may be linked
to the originating ControllerForm
through the
ControllerForm
Id.
The delete operations delete Controllers
in bulk. To
unmap a Controller
from the current System,
the ControllerSystemAssignmentSession
should be used. These
delete operations attempt to remove the Controller
itself
thus removing it from all known System
catalogs. Bulk
delete operations return the results in DeleteControllers.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasControllers(AliasRequestList aliasRequests)
Adds an
Id to a Controller for the
purpose of creating compatibility. |
CreateResponseList |
createControllers(ControllerBatchFormList controllerForms)
Creates a new set of
Controllers. |
DeleteResponseList |
deleteAllControllers()
Deletes all
Controllers in this System. |
DeleteResponseList |
deleteControllers(IdList controllerIds)
Deletes controllers for the given
Ids. |
ControllerBatchFormList |
getControllerFormsForCreate(long n,
Type[] controllerRecordTypes)
Gets the controller forms for creating a bunch of new controllers.
|
ControllerBatchFormList |
getControllerFormsForUpdate(IdList controllerIds)
Gets the controller forms for updating an existing set of controllers.
|
UpdateResponseList |
updateControllers(ControllerBatchFormList controllerForms)
Updates existing controllers.
|
aliasController, canCreateController, canCreateControllerWithRecordTypes, canDeleteControllers, canManageControllerAliases, canUpdateControllers, createController, deleteController, getControllerFormForCreate, getControllerFormForUpdate, getSystem, getSystemId, updateController
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ControllerBatchFormList getControllerFormsForCreate(long n, Type[] controllerRecordTypes) throws OperationFailedException, PermissionDeniedException
n
- the number of forms to retrievecontrollerRecordTypes
- array of controller record types to be
included in each create operation or an empty list if noneNullArgumentException
- controllerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createControllers(ControllerBatchFormList controllerForms) throws OperationFailedException, PermissionDeniedException
Controllers.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateController
.controllerForms
- the controller formsNullArgumentException
- controllerForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ControllerBatchFormList getControllerFormsForUpdate(IdList controllerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
controllerIds
- the Ids
of the Controller
NotFoundException
- a controllerId
is
not foundNullArgumentException
- controllerIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateControllers(ControllerBatchFormList controllerForms) throws OperationFailedException, PermissionDeniedException
BatchCreateController
.controllerForms
- the form containing the elements to be updatedNullArgumentException
- controllerForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllControllers() throws OperationFailedException, PermissionDeniedException
Controllers
in this System.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteControllers(IdList controllerIds) throws OperationFailedException, PermissionDeniedException
Ids.
controllerIds
- the Ids
of the controllers to
deleteNullArgumentException
- controllerIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasControllers(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Controller
for the
purpose of creating compatibility. The primary Id
of
the Controller
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another controller, it is reassigned to the
given controller Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.