public interface CommitmentBatchAdminSession extends CommitmentAdminSession
This session creates, updates, and deletes Commitments
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
Commitment,
a CommitmentForm
is requested using
getCommitmentFormsForCreate()
specifying the event,
resource, and desired record Types
or none if no record
Types
are needed. Each of the returned
CommitmentForms
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 CommitmentForm
is submiited to a create
operation, it cannot be reused with another create operation unless the
first operation was unsuccessful. Each CommitmentForm
corresponds to an attempted transaction.
The CommitmentForms
returned from
getCommitmentFormsForCreate()
may be linked to the originating
request through the peer Ids
of the CommitmentForm.
In the case where there may be duplicates, any
CommitmentForm
of the same peer Ids
may be used for
a create operation.
Once a batch of CommitmentForms
are submitted for
create, a CreateResponse
is returned for each
CommitmentForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createCommitments(),
errors specific to an individual
CommitmentForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating CommitmentForm
through the
CommitmentForm
Id
.
For updates, CommitmentForms
are requested to the
Commitment
Id
that is to be updated using
getCommitmentFormsForUpdate()
where the reference Id
in the CommitmentForm
may be used to link the
request. Similarly, the CommitmentForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The CommitmentForm
can only be used
once for a successful update and cannot be reused.
Once a batch of CommitmentForms
are submitted for
update, an UpdateResponse
is returned for each
CommitmentForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateCommitments(),
errors specific to an individual
CommitmentForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating CommitmentForm
through the
CommitmentForm
Id.
The delete operations delete Commitments
in bulk. To
unmap a Commitment
from the current Calendar,
the CommitmentCalendarAssignmentSession
should be
used. These delete operations attempt to remove the Commitment
itself thus removing it from all known Calendar
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasCommitments(AliasRequestList aliasRequests)
Adds an
Id to a Commitment for the
purpose of creating compatibility. |
CreateResponseList |
createCommitments(CommitmentBatchFormList commitmentForms)
Creates a new set of
Commitments. |
DeleteResponseList |
deleteAllCommitments()
Deletes all
Commitments in this Calendar
. |
DeleteResponseList |
deleteCommitments(IdList commitmentIds)
Deletes commitments for the given
Ids. |
DeleteResponseList |
deleteCommitmentsForEvent(Id eventId)
Deletes all commitments related to the given event.
|
DeleteResponseList |
deleteCommitmentsForResource(Id resourceId)
Deletes all commitments related to the given resource.
|
DeleteResponseList |
deleteIneffectiveCommitmentsByDate(DateTime date)
Deletes all commitments expired before the given date.
|
CommitmentBatchFormList |
getCommitmentFormsForCreate(CommitmentPeerList peers,
Type[] commitmentRecordTypes)
Gets the commitmentforms for creating a bunch of new commitments.
|
CommitmentBatchFormList |
getCommitmentFormsForUpdate(IdList commitmentIds)
Gets the commitment forms for updating an existing set of commitments.
|
UpdateResponseList |
updateCommitments(CommitmentBatchFormList commitmentForms)
Updates existing commitments.
|
aliasCommitment, canCreateCommitments, canCreateCommitmentWithRecordTypes, canDeleteCommitments, canManageCommitmentAliases, canUpdateCommitments, createCommitment, deleteCommitment, getCalendar, getCalendarId, getCommitmentFormForCreate, getCommitmentFormForUpdate, updateCommitment
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CommitmentBatchFormList getCommitmentFormsForCreate(CommitmentPeerList peers, Type[] commitmentRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- a list of commitment peerscommitmentRecordTypes
- array of commitment record types to be
included in each create operation or an empty list if noneNotFoundException
- an eventId
or
resourceId
is not foundNullArgumentException
- peers
or
commitmentRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createCommitments(CommitmentBatchFormList commitmentForms) throws OperationFailedException, PermissionDeniedException
Commitments.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.commitmentForms
- the commitment formsNullArgumentException
- commitmentForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentBatchFormList getCommitmentFormsForUpdate(IdList commitmentIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
commitmentIds
- the Ids
of the Commitment
NotFoundException
- a commitmentId
is
not foundNullArgumentException
- commitmentIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateCommitments(CommitmentBatchFormList commitmentForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.commitmentForms
- the form containing the elements to be updatedNullArgumentException
- commitmentForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllCommitments() throws OperationFailedException, PermissionDeniedException
Commitments
in this Calendar
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteCommitments(IdList commitmentIds) throws OperationFailedException, PermissionDeniedException
Ids.
commitmentIds
- the Ids
of the commitments to
deleteNullArgumentException
- commitmentIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteCommitmentsForEvent(Id eventId) throws OperationFailedException, PermissionDeniedException
eventId
- an Id
of an eventNullArgumentException
- eventId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteCommitmentsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- an Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveCommitmentsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasCommitments(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Commitment
for the
purpose of creating compatibility. The primary Id
of
the Commitment
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another commitment, it is reassigned to the
given commitment Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.