public interface UtilityBatchAdminSession extends UtilityAdminSession
This session creates, updates, and deletes Utilities
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
Utility,
a UtilityForm
is requested using
getUtilityFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed. Each
of the returned UtilityForms
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 UtilityForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
UtilityForm
corresponds to an attempted transaction.
The UtilityForms
returned from
getUtilityFormsForCreate()
may be linked to the originating
request through the peer Ids
of the UtilityForm.
In the case where there may be duplicates, any UtilityForm
of the same peer Ids
may be used for a create
operation.
Once a batch of UtilityForms
are submitted for create,
a CreateResponse
is returned for each UtilityForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createUtilities(),
errors specific to an individual UtilityForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
UtilityForm
through the UtilityForm
Id
.
For updates, UtilityForms
are requested to the
Utility
Id
that is to be updated using
getUtilityFormsForUpdate()
where the reference Id
in the UtilityForm
may be used to link the request.
Similarly, the UtilityForm
has metadata about the data that
can be updated and it can perform validation before submitting the update.
The UtilityForm
can only be used once for a successful
update and cannot be reused.
Once a batch of UtilityForms
are submitted for update,
an UpdateResponse
is returned for each UtilityForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateUtilities(),
errors specific to an individual UtilityForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
UtilityForm
through the UtilityForm
Id.
The delete operations delete Utilities
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasUtilities(AliasRequestList aliasRequests)
Adds an
Id to a Utility for the purpose
of creating compatibility. |
CreateResponseList |
createUtilities(UtilityBatchFormList utilityForms)
Creates a new set of
Utilities. |
DeleteResponseList |
deleteAllUtilities()
Deletes all
Utilities. |
DeleteResponseList |
deleteUtilities(IdList utilityIds)
Deletes utilities for the given
Ids. |
UtilityBatchFormList |
getUtilityFormsForCreate(long number,
Type[] utilityRecordTypes)
Gets the utility forms for creating a bunch of new utilities.
|
UtilityBatchFormList |
getUtilityFormsForUpdate(IdList utilityIds)
Gets the utility forms for updating an existing set of utilities.
|
UpdateResponseList |
updateUtilities(UtilityBatchFormList utilityForms)
Updates existing utilities.
|
aliasUtility, canCreateUtilities, canCreateUtilityWithRecordTypes, canDeleteUtilities, canManageUtilityAliases, canUpdateUtilities, createUtility, deleteUtility, getUtilityFormForCreate, getUtilityFormForUpdate, updateUtility
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
UtilityBatchFormList getUtilityFormsForCreate(long number, Type[] utilityRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveutilityRecordTypes
- array of utility record types to be
included in each create operation or an empty list if noneNullArgumentException
- utilityRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createUtilities(UtilityBatchFormList utilityForms) throws OperationFailedException, PermissionDeniedException
Utilities.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.utilityForms
- the utility formsNullArgumentException
- utilityForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UtilityBatchFormList getUtilityFormsForUpdate(IdList utilityIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
utilityIds
- the Ids
of the Utility
NotFoundException
- a utilityId
is not
foundNullArgumentException
- utilityIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateUtilities(UtilityBatchFormList utilityForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.utilityForms
- the form containing the elements to be updatedNullArgumentException
- utilityForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllUtilities() throws OperationFailedException, PermissionDeniedException
Utilities.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteUtilities(IdList utilityIds) throws OperationFailedException, PermissionDeniedException
Ids.
utilityIds
- the Ids
of the utilities to deleteNullArgumentException
- utilityIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasUtilities(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Utility
for the purpose
of creating compatibility. The primary Id
of the
Utility
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another utility, it is reassigned to the given utility
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.