public interface AcademyBatchAdminSession extends AcademyAdminSession
This session creates, updates, and deletes Academies
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
Academy,
a AcademyForm
is requested using
getAcademyFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed. Each
of the returned AcademyForms
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 AcademyForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
AcademyForm
corresponds to an attempted transaction.
The AcademyForms
returned from
getAcademyFormsForCreate()
may be linked to the originating
request through the peer Ids
of the AcademyForm.
In the case where there may be duplicates, any AcademyForm
of the same peer Ids
may be used for a create
operation.
Once a batch of AcademyForms
are submitted for create,
a CreateResponse
is returned for each AcademyForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createAcademy(),
errors specific to an individual AcademyForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
AcademyForm
through the AcademyForm
Id
.
For updates, AcademyForms
are requested to the
Academy
Id
that is to be updated using
getAcademyFormsForUpdate()
where the reference Id
in the AcademyForm
may be used to link the request.
Similarly, the AcademyForm
has metadata about the data that
can be updated and it can perform validation before submitting the update.
The AcademyForm
can only be used once for a successful
update and cannot be reused.
Once a batch of AcademyForms
are submitted for update,
an UpdateResponse
is returned for each AcademyForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateAcademy(),
errors specific to an individual AcademyForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
AcademyForm
through the AcademyForm
Id.
The delete operations delete Academies
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasAcademies(AliasRequestList aliasRequests)
Adds an
Id to a Academy for the purpose
of creating compatibility. |
CreateResponseList |
createAcademies(AcademyBatchFormList academyForms)
Creates a new set of
Academies. |
DeleteResponseList |
deleteAcademies(IdList academyIds)
Deletes academies for the given
Ids. |
DeleteResponseList |
deleteAllAcademies()
Deletes all
Academies. |
AcademyBatchFormList |
getAcademyFormsForCreate(long number,
Type[] academyRecordTypes)
Gets the academy forms for creating a bunch of new academy.
|
AcademyBatchFormList |
getAcademyFormsForUpdate(IdList academyIds)
Gets the academy forms for updating an existing set of academies.
|
UpdateResponseList |
updateAcademies(AcademyBatchFormList academyForms)
Updates existing academies.
|
aliasAcademy, canCreateAcademies, canCreateAcademyWithRecordTypes, canDeleteAcademies, canManageAcademyAliases, canUpdateAcademies, createAcademy, deleteAcademy, getAcademyFormForCreate, getAcademyFormForUpdate, updateAcademy
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AcademyBatchFormList getAcademyFormsForCreate(long number, Type[] academyRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveacademyRecordTypes
- array of academy record types to be
included in each create operation or an empty list if noneNullArgumentException
- academyRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createAcademies(AcademyBatchFormList academyForms) throws OperationFailedException, PermissionDeniedException
Academies.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.academyForms
- the academy formsNullArgumentException
- academyForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AcademyBatchFormList getAcademyFormsForUpdate(IdList academyIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
academyIds
- the Ids
of the Academies
NotFoundException
- a academyId
is not
foundNullArgumentException
- academyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateAcademies(AcademyBatchFormList academyForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.academyForms
- the form containing the elements to be updatedNullArgumentException
- academyForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllAcademies() throws OperationFailedException, PermissionDeniedException
Academies.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAcademies(IdList academyIds) throws OperationFailedException, PermissionDeniedException
Ids.
academyIds
- the Ids
of the academies to deleteNullArgumentException
- academyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasAcademies(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Academy
for the purpose
of creating compatibility. The primary Id
of the
Academy
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another academy, it is reassigned to the given academy
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.