public interface AwardBatchAdminSession extends AwardAdminSession
This session creates, updates, and deletes Awards
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 an
Award,
an AwardForm
is requested using
getAwardFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed.
Each of the returned AwardForms
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 an AwardForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
AwardForm
corresponds to an attempted transaction.
The AwardForms
returned from
getAwardFormsForCreate()
may be linked to the originating request
through the peer Ids
of the AwardForm.
In
the case where there may be duplicates, any AwardForm
of
the same peer Ids
may be used for a create operation.
Once a batch of AwardForms
are submitted for create, a
CreateResponse
is returned for each AwardForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createAwards(),
errors specific to an individual AwardForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating AwardForm
through the AwardForm
Id
.
For updates, AwardForms
are requested to the
Award
Id
that is to be updated using
getAwardFormsForUpdate()
where the reference Id
in
the AwardForm
may be used to link the request. Similarly,
the AwardForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
AwardForm
can only be used once for a successful update and
cannot be reused.
Once a batch of AwardForms
are submitted for update, an
UpdateResponse
is returned for each AwardForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateAwards(),
errors specific to an individual AwardForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating AwardForm
through the AwardForm
Id.
The delete operations delete Awards
in bulk. To unmap
an Award
from the current Academy,
the
AwardAcademyAssignmentSession
should be used. These delete
operations attempt to remove the Award
itself thus removing
it from all known Academy
catalogs. Bulk delete operations
return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasAwards(AliasRequestList aliasRequests)
Adds an
Id to an Award for the purpose
of creating compatibility. |
CreateResponseList |
createAwards(AwardBatchFormList awardForms)
Creates a new set of
Awards. |
DeleteResponseList |
deleteAllAwards()
Deletes all
Awards in this Academy . |
DeleteResponseList |
deleteAwards(IdList awardIds)
Deletes awards for the given
Ids. |
AwardBatchFormList |
getAwardFormsForCreate(long number,
Type[] awardRecordTypes)
Gets the award forms for creating a bunch of new awards.
|
AwardBatchFormList |
getAwardFormsForUpdate(IdList awardIds)
Gets the award forms for updating an existing set of awards.
|
UpdateResponseList |
updateAwards(AwardBatchFormList awardForms)
Updates existing awards.
|
aliasAward, canCreateAwards, canCreateAwardWithRecordTypes, canDeleteAwards, canManageAwardAliases, canUpdateAwards, createAward, deleteAward, getAcademy, getAcademyId, getAwardFormForCreate, getAwardFormForUpdate, updateAward
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AwardBatchFormList getAwardFormsForCreate(long number, Type[] awardRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveawardRecordTypes
- array of award record types to be included in
each create operation or an empty list if noneNullArgumentException
- awardRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createAwards(AwardBatchFormList awardForms) throws OperationFailedException, PermissionDeniedException
Awards.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.awardForms
- the award formsNullArgumentException
- awardForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardBatchFormList getAwardFormsForUpdate(IdList awardIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
awardIds
- the Ids
of the Award
NotFoundException
- an awardId
is not
foundNullArgumentException
- awardIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateAwards(AwardBatchFormList awardForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.awardForms
- the form containing the elements to be updatedNullArgumentException
- awardForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllAwards() throws OperationFailedException, PermissionDeniedException
Awards
in this Academy
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAwards(IdList awardIds) throws OperationFailedException, PermissionDeniedException
Ids.
awardIds
- the Ids
of the awards to deleteNullArgumentException
- awardIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasAwards(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Award
for the purpose
of creating compatibility. The primary Id
of the
Award
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is a
pointer to another award, it is reassigned to the given award
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.