public interface GradebookColumnBatchAdminSession extends GradebookColumnAdminSession
This session creates, updates, and deletes GradebookColumns
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
GradebookColumn,
GradebookColumnForm
is requested
using getGradebookColumnFormsForCreate()
specifying the
desired record Types
or none if no record Types
are needed. Each of the returned GradebookColumnForms
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
GradebookColumnForm
is submiited to a create operation, it
cannot be reused with another create operation unless the first operation
was unsuccessful. Each GradebookColumnForm
corresponds to
an attempted transaction.
The GradebookColumnForms
returned from
getGradebookColumnFormsForCreate()
may be linked to the
originating request through the peer Ids
of the
GradebookColumnForm.
In the case where there may be duplicates,
any GradebookColumnForm
of the same peer Ids
may be used for a create operation.
Once a batch of GradebookColumnForms
are submitted for
create, a CreateResponse
is returned for each
GradebookColumnForm,
although the ordering is not defined. Only
errors that pertain to the entire create operation are returned from
createGradebookColumns(),
errors specific to an individual
GradebookColumnForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be
linked to the originating GradebookColumnForm
through the
GradebookColumnForm
Id
.
For updates, GradebookColumnForms
are requested to the
GradebookColumn
Id
that is to be updated
using getGradebookColumnFormsForUpdate()
where the
reference Id
in the GradebookColumnForm
may
be used to link the request. Similarly, the GradebookColumnForm
has metadata about the data that can be updated and it can perform
validation before submitting the update. The GradebookColumnForm
can only be used once for a successful update and cannot be
reused.
Once a batch of GradebookColumnForms
are submitted for
update, an UpdateResponse
is returned for each
GradebookColumnForm,
although the ordering is not defined. Only
errors that pertain to the entire update operation are returned from
updateGradebookColumns(),
errors specific to an individual
GradebookColumnForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be
linked to the originating GradebookColumnForm
through the
GradebookColumnForm
Id.
The delete operations delete GradebookColumns
in bulk.
To unmap a GradebookColumn
from the current
Gradebook,
the GradebookColumnGradebookAssignmentSession
should be used. These delete operations attempt to remove the
GradebookColumn
itself thus removing it from all known
Gradebook
catalogs. Bulk delete operations return the
results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasGradebookColumns(AliasRequestList aliasRequests)
Adds an
Id to a GradebookColumn for the
purpose of creating compatibility. |
CreateResponseList |
createGradebookColumns(GradebookColumnBatchFormList gradebookColumnForms)
Creates a new set of
GradebookColumns. |
DeleteResponseList |
deleteAllGradebookColumns()
Deletes all
GradebookColumns in this Gradebook
. |
DeleteResponseList |
deleteGradebookColumns(IdList gradebookColumnIds)
Deletes gradebook columns for the given
Ids. |
GradebookColumnBatchFormList |
getGradebookColumnFormsForCreate(Type[] gradebookColumnRecordTypes)
Gets the gradebook column forms for creating a bunch of new gradebook
columns.
|
GradebookColumnBatchFormList |
getGradebookColumnFormsForUpdate(IdList gradebookColumnIds)
Gets the gradebook column forms for updating an existing set of
gradebook columns.
|
UpdateResponseList |
updateGradebookColumns(GradebookColumnBatchFormList gradebookColumnForms)
Updates existing gradebook columns.
|
aliasGradebookColumn, canCreateGradebookColumns, canCreateGradebookColumnWithRecordTypes, canDeleteGradebookColumns, canManageGradebookColumnAliases, canUpdateGradebookColumns, copyGradebookColumnEntries, createGradebookColumn, deleteGradebookColumn, getGradebook, getGradebookColumnFormForCreate, getGradebookColumnFormForUpdate, getGradebookId, moveGradebookColumn, sequenceGradebookColumns, updateGradebookColumn
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
GradebookColumnBatchFormList getGradebookColumnFormsForCreate(Type[] gradebookColumnRecordTypes) throws OperationFailedException, PermissionDeniedException
gradebookColumnRecordTypes
- array of gradebook columnrecord
types to be included in each create operation or an empty list
if noneNullArgumentException
- peers
or
gradebookColumnRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createGradebookColumns(GradebookColumnBatchFormList gradebookColumnForms) throws OperationFailedException, PermissionDeniedException
GradebookColumns.
This method
returns an error if the entire operation fails. Otherwise, the status
of an individual create operation is indicated in the
BatchCreateResponse
.gradebookColumnForms
- the gradebook column formsNullArgumentException
- gradebookColumnForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookColumnBatchFormList getGradebookColumnFormsForUpdate(IdList gradebookColumnIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
gradebookColumnIds
- the Ids
of the
GradebookColumn
NotFoundException
- a gradebookColumnId
is not foundNullArgumentException
- gradebookColumnIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateGradebookColumns(GradebookColumnBatchFormList gradebookColumnForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.gradebookColumnForms
- the form containing the elements to be
updatedNullArgumentException
- gradebookColumnForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllGradebookColumns() throws OperationFailedException, PermissionDeniedException
GradebookColumns
in this Gradebook
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteGradebookColumns(IdList gradebookColumnIds) throws OperationFailedException, PermissionDeniedException
Ids.
gradebookColumnIds
- the Ids
of the gradebook
columns to deleteNullArgumentException
- gradebookColumnIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasGradebookColumns(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a GradebookColumn
for the
purpose of creating compatibility. The primary Id
of
the GradebookColumn
is determined by the provider. The
new Id
is an alias to the primary Id.
If
the alias is a pointer to another gradebook column, it is reassigned
to the given gradebook column Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.