public interface ProvisionBatchAdminSession extends ProvisionAdminSession
This session creates, updates, and deletes Provisions
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
Provision,
a ProvisionForm
is requested using
getProvisionFormsForCreate()
specifying the desired
provisionable, request, broker, record Types
or none if no
record Types
are needed. Each of the returned
ProvisionForms
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 ProvisionForm
is submiited to a create
operation, it cannot be reused with another create operation unless the
first operation was unsuccessful. Each ProvisionForm
corresponds to an attempted transaction.
The ProvisionForms
returned from
getProvisionFormsForCreate()
may be linked to the originating
request through the peer Ids
of the ProvisionForm.
In the case where there may be duplicates, any
ProvisionForm
of the same peer Ids
may be used for
a create operation.
Once a batch of ProvisionForms
are submitted for
create, a CreateResponse
is returned for each
ProvisionForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createProvisions(),
errors specific to an individual
ProvisionForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating ProvisionForm
through the
ProvisionForm
Id
.
For updates, ProvisionForms
are requested to the
Provision
Id
that is to be updated using
getProvisionFormsForUpdate()
where the reference Id
in the ProvisionForm
may be used to link the request.
Similarly, the ProvisionForm
has metadata about the data
that can be updated and it can perform validation before submitting the
update. The ProvisionForm
can only be used once for a
successful update and cannot be reused.
Once a batch of ProvisionForms
are submitted for
update, an UpdateResponse
is returned for each
ProvisionForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateProvisions(),
errors specific to an individual
ProvisionForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating ProvisionForm
through the
ProvisionForm
Id.
The delete operations delete Provisions
in bulk. To
unmap a Provision
from the current Distributor,
the ProvisionDistributorAssignmentSession
should be
used. These delete operations attempt to remove the Provision
itself thus removing it from all known Distributor
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasProvisions(AliasRequestList aliasRequests)
Adds an
Id to a Provision for the
purpose of creating compatibility. |
CreateResponseList |
createProvisions(ProvisionBatchFormList provisionForms)
Creates a new set of
Provisions. |
DeleteResponseList |
deleteAllProvisions()
Deletes all
Provisions in this Distributor
. |
DeleteResponseList |
deleteIneffectiveProvisionsByDate(DateTime date)
Deletes provisions expired before the given date.
|
DeleteResponseList |
deleteProvisions(IdList provisionIds)
Deletes provisions for the given
Ids. |
DeleteResponseList |
deleteProvisionsForBroker(Id brokerId)
Deletes provisions for the given broker.
|
DeleteResponseList |
deleteProvisionsForProvisionable(Id provisionableId)
Deletes provisions for the given provisionable.
|
DeleteResponseList |
deleteProvisionsForRecipient(Id resourceId)
Deletes provisions for the given recipient.
|
DeleteResponseList |
deleteProvisionsForRequest(Id requestId)
Deletes provisions for the given request.
|
ProvisionBatchFormList |
getProvisionFormsForCreate(long peers,
Type[] provisionRecordTypes)
Gets the provision forms for creating a bunch of new provisions.
|
ProvisionBatchFormList |
getProvisionFormsForUpdate(IdList provisionIds)
Gets the provision forms for updating an existing set of provisions.
|
UpdateResponseList |
updateProvisions(ProvisionBatchFormList provisionForms)
Updates existing provisions.
|
aliasProvision, canCreateProvisions, canCreateProvisionWithRecordTypes, canDeleteProvisions, canManageProvisionAliases, canUpdateProvisions, createProvision, deleteProvision, getDistributor, getDistributorId, getProvisionFormForCreate, getProvisionFormForUpdate, updateProvision
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProvisionBatchFormList getProvisionFormsForCreate(long peers, Type[] provisionRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- a list of provision peersprovisionRecordTypes
- array of provision record types to be
included in each create operation or an empty list if noneNotFoundException
- a provisionableId,
requestId,
or brokerId
is not
foundNullArgumentException
- peers
or
provisionRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createProvisions(ProvisionBatchFormList provisionForms) throws OperationFailedException, PermissionDeniedException
Provisions.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.provisionForms
- the provision formsNullArgumentException
- provisionForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionBatchFormList getProvisionFormsForUpdate(IdList provisionIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
provisionIds
- the Ids
of the Provision
NotFoundException
- a provisionId
is not
foundNullArgumentException
- provisionIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateProvisions(ProvisionBatchFormList provisionForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.provisionForms
- the form containing the elements to be updatedNullArgumentException
- provisionForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllProvisions() throws OperationFailedException, PermissionDeniedException
Provisions
in this Distributor
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProvisions(IdList provisionIds) throws OperationFailedException, PermissionDeniedException
Ids.
provisionIds
- the Ids
of the provisions to
deleteNullArgumentException
- provisionIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProvisionsForBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
brokerId
- the Id
of a brokerNullArgumentException
- brokerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProvisionsForProvisionable(Id provisionableId) throws OperationFailedException, PermissionDeniedException
provisionableId
- the Id
of a provisionableNullArgumentException
- provisionableId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProvisionsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProvisionsForRequest(Id requestId) throws OperationFailedException, PermissionDeniedException
requestId
- the Id
of a requestNullArgumentException
- requestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveProvisionsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasProvisions(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Provision
for the
purpose of creating compatibility. The primary Id
of
the Provision
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another provision, it is reassigned to the given
provision Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.