public interface CookbookBatchAdminSession extends CookbookAdminSession
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
Cookbook,
a CookbookForm
is requested using
getCookbookFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed. Each
of the returned CookbookForms
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 CookbookForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
CookbookForm
corresponds to an attempted transaction.
The CookbookForms
returned from
getCookbookFormsForCreate()
may be linked to the originating
request through the peer Ids
of the CookbookForm.
In the case where there may be duplicates, any CookbookForm
of the same peer Ids
may be used for a create
operation.
Once a batch of CookbookForms
are submitted for create,
a CreateResponse
is returned for each CookbookForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createCookbook(),
errors specific to an individual CookbookForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
CookbookForm
through the CookbookForm
Id
.
For updates, CookbookForms
are requested to the
Cookbook
Id
that is to be updated using
getCookbookFormsForUpdate()
where the reference Id
in the CookbookForm
may be used to link the request.
Similarly, the CookbookForm
has metadata about the data
that can be updated and it can perform validation before submitting the
update. The CookbookForm
can only be used once for a
successful update and cannot be reused.
Once a batch of CookbookForms
are submitted for update,
an UpdateResponse
is returned for each CookbookForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateCookbook(),
errors specific to an individual CookbookForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
CookbookForm
through the CookbookForm
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 Cookbook for the purpose
of creating compatibility. |
CreateResponseList |
createAcademies(CookbookBatchFormList cookbookForms)
Creates a new set of
Academies. |
DeleteResponseList |
deleteAcademies(IdList cookbookIds)
Deletes cook books for the given
Ids. |
DeleteResponseList |
deleteAllAcademies()
Deletes all
Academies. |
CookbookBatchFormList |
getCookbookFormsForCreate(long number,
Type[] cookbookRecordTypes)
Gets the cookbook forms for creating a bunch of new cookbook.
|
CookbookBatchFormList |
getCookbookFormsForUpdate(IdList cookbookIds)
Gets the cookbook forms for updating an existing set of academies.
|
UpdateResponseList |
updateAcademies(CookbookBatchFormList cookbookForms)
Updates existing academies.
|
aliasCookbook, canCreateCookbooks, canCreateCookbookWithRecordTypes, canDeleteCookbooks, canManageCookbookAliases, canUpdateCookbooks, createCookbook, deleteCookbook, getCookbookFormForCreate, getCookbookFormForUpdate, updateCookbook
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CookbookBatchFormList getCookbookFormsForCreate(long number, Type[] cookbookRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievecookbookRecordTypes
- array of cookbook record types to be
included in each create operation or an empty list if noneNullArgumentException
- cookbookRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createAcademies(CookbookBatchFormList cookbookForms) 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
.cookbookForms
- the cookbook formsNullArgumentException
- cookbookForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CookbookBatchFormList getCookbookFormsForUpdate(IdList cookbookIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
cookbookIds
- the Ids
of the Academies
NotFoundException
- a cookbookId
is not
foundNullArgumentException
- cookbookIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateAcademies(CookbookBatchFormList cookbookForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.cookbookForms
- the form containing the elements to be updatedNullArgumentException
- cookbookForms
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 cookbookIds) throws OperationFailedException, PermissionDeniedException
Ids.
cookbookIds
- the Ids
of the cook books to deleteNullArgumentException
- cookbookIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasAcademies(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Cookbook
for the purpose
of creating compatibility. The primary Id
of the
Cookbook
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another cookbook, it is reassigned to the given cookbook
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.