public interface GradebookBatchAdminSession extends GradebookAdminSession
This session creates, updates, and deletes Gradebooks
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
Gradebook,
a GradebookForm
is requested using
getGradebookFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed.
Each of the returned GradebookForms
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 GradebookForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
GradebookForm
corresponds to an attempted transaction.
The GradebookForms
returned from
getGradebookFormForCreate()
may be linked to the originating
request through the peer Ids
of the GradebookForm
In the case where there may be duplicates, any
GradebookForm
of the same peer Ids
may be used for
a create operation.
Once a batch of GradebookForm
are submitted for create,
a CreateResponse
is returned for each GradebookForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createGradebooks(),
errors specific to an individual GradebookForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
GradebookForm
through the GradebookForm
Id
.
For updates, GradebookForm
are requested to the
Gradebook
Id
that is to be updated using
getGradebookFormsForUpdate()
where the reference Id
in the Gradebook
may be used to link the request.
Similarly, the Gradebook
has metadata about the data that
can be updated and it can perform validation before submitting the update.
The Gradebook
can only be used once for a successful update
and cannot be reused.
Once a batch of GradebookForms
are submitted for
update, an UpdateResponse
is returned for each
GradebookForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateGradebooks(),
errors specific to an individual
GradebookForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating GradebookForm
through the
GradebookForm
Id.
The delete operations delete Gradebooks
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasGradebooks(AliasRequestList aliasRequests)
Adds an
Id to a Gradebook for the
purpose of creating compatibility. |
CreateResponseList |
createGradebooks(GradebookBatchFormList gradebookForms)
Creates a new set of
Gradebooks. |
DeleteResponseList |
deleteAllGradebooks()
Deletes all
Gradebooks. |
DeleteResponseList |
deleteGradebooks(IdList gradebookIds)
Deletes gradebooks for the given
Ids. |
GradebookBatchFormList |
getGradebookFormsForCreate(long number,
Type[] gradebookRecordTypes)
Gets the gradebook forms for creating a bunch of new gradebooks.
|
GradebookBatchFormList |
getGradebookFormsForUpdate(IdList gradebookIds)
Gets the gradebook forms for updating an existing set of gradebooks.
|
UpdateResponseList |
updateGradebooks(GradebookBatchFormList gradebookForms)
Updates existing gradebooks.
|
aliasGradebook, canCreateGradebooks, canCreateGradebookWithRecordTypes, canDeleteGradebooks, canManageGradebookAliases, canUpdateGradebooks, createGradebook, deleteGradebook, getGradebookFormForCreate, getGradebookFormForUpdate, updateGradebook
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
GradebookBatchFormList getGradebookFormsForCreate(long number, Type[] gradebookRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievegradebookRecordTypes
- array of gradebook record types to be
included in each create operation or an empty list if noneNullArgumentException
- gradebookRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createGradebooks(GradebookBatchFormList gradebookForms) throws OperationFailedException, PermissionDeniedException
Gradebooks.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.gradebookForms
- the gradebook formsNullArgumentException
- gradebookForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookBatchFormList getGradebookFormsForUpdate(IdList gradebookIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
gradebookIds
- the Ids
of the Gradebook
NotFoundException
- a gradebookId
is not
foundNullArgumentException
- gradebookIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateGradebooks(GradebookBatchFormList gradebookForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.gradebookForms
- the form containing the elements to be updatedNullArgumentException
- gradebookForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllGradebooks() throws OperationFailedException, PermissionDeniedException
Gradebooks.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteGradebooks(IdList gradebookIds) throws OperationFailedException, PermissionDeniedException
Ids.
gradebookIds
- the Ids
of the gradebooks to
deleteNullArgumentException
- gradebookIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasGradebooks(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Gradebook
for the
purpose of creating compatibility. The primary Id
of
the Gradebook
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another gradebook, it is reassigned to the given
gradebook Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.