public interface GradeSystemBatchAdminSession extends GradeSystemAdminSession
This session creates, updates, and deletes GradeSystems
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
GradeSystem,
a GradeSystemForm
is requested using
getGradeSystemFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned GradeSystemForms
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 GradeSystemForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
GradeSystemForm
corresponds to an attempted transaction.
The GradeSystemForms
returned from
getGradeSystemFormsForCreate()
may be linked to the originating
request through the peer Ids
of the GradeSystemForm.
In the case where there may be duplicates, any
GradeSystemForm
of the same peer Ids
may be used
for a create operation.
Once a batch of GradeSystemForms
are submitted for
create, a CreateResponse
is returned for each
GradeSystemForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createGradeSystems(),
errors specific to an individual
GradeSystemForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating GradeSystemForm
through the
GradeSystemForm
Id
.
For updates, GradeSystemForms
are requested to the
GradeSystem
Id
that is to be updated using
getGradeSystemFormsForUpdate()
where the reference
Id
in the GradeSystemForm
may be used to link the
request. Similarly, the GradeSystemForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The GradeSystemForm
can only be used
once for a successful update and cannot be reused.
Once a batch of GradeSystemForms
are submitted for
update, an UpdateResponse
is returned for each
GradeSystemForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateGradeSystems(),
errors specific to an individual
GradeSystemForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating GradeSystemForm
through the
GradeSystemForm
Id.
The delete operations delete GradeSystems
in bulk. To
unmap a GradeSystem
from the current Gradebook,
the GradeSystemGradebookAssignmentSession
should be
used. These delete operations attempt to remove the GradeSystem
itself thus removing it from all known Gradebook
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasGrades(AliasRequestList aliasRequests)
Adds an
Id to a Grade for the purpose of
creating compatibility. |
AliasResponseList |
aliasGradeSystems(AliasRequestList aliasRequests)
Adds an
Id to a GradeSystem for the
purpose of creating compatibility. |
CreateResponseList |
createGrades(GradeBatchFormList gradeForms)
Creates a new set of
GradeSystems. |
CreateResponseList |
createGradeSystems(GradeSystemBatchFormList gradeSystemForms)
Creates a new set of
GradeSystems. |
DeleteResponseList |
deleteAllGrades()
Deletes all
Grades in this Gradebook . |
DeleteResponseList |
deleteAllGradeSystems()
Deletes all
GradeSystems in this Gradebook
. |
DeleteResponseList |
deleteGrades(IdList gradeIds)
Deletes grade for the given
Ids. |
DeleteResponseList |
deleteGradesForGradeSystem(Id gradeSystemId)
Deletes grade for the given grade system.
|
DeleteResponseList |
deleteGradeSystems(IdList gradeSystemIds)
Deletes grade systems for the given
Ids. |
GradeBatchFormList |
getGradeFormsForCreate(IdList gradeSystemIds,
Type[] gradeRecordTypes)
Gets the grade forms for creating a bunch of new grades.
|
GradeBatchFormList |
getGradeFormsForUpdate(IdList gradeIds)
Gets the grade forms for updating an existing set of grade systems.
|
GradeSystemBatchFormList |
getGradeSystemFormsForCreate(long number,
Type[] gradeSystemRecordTypes)
Gets the grade system forms for creating a bunch of new grade systems.
|
GradeSystemBatchFormList |
getGradeSystemFormsForUpdate(IdList gradeSystemIds)
Gets the grade system forms for updating an existing set of grade
systems.
|
UpdateResponseList |
updateGrades(GradeBatchFormList gradeForms)
Updates existing grades.
|
UpdateResponseList |
updateGradeSystems(GradeSystemBatchFormList gradeSystemForms)
Updates existing grade systems.
|
aliasGrade, aliasGradeSystem, canCreateGrades, canCreateGradeSystems, canCreateGradeSystemWithRecordTypes, canCreateGradeWithRecordTypes, canDeleteGrades, canDeleteGradeSystems, canManageGradeAliases, canManageGradeSystemAliases, canUpdateGrades, canUpdateGradeSystems, createGrade, createGradeSystem, deleteGrade, deleteGradeSystem, getGradebook, getGradebookId, getGradeFormForCreate, getGradeFormForUpdate, getGradeSystemFormForCreate, getGradeSystemFormForUpdate, updateGrade, updateGradeSystem
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
GradeSystemBatchFormList getGradeSystemFormsForCreate(long number, Type[] gradeSystemRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievegradeSystemRecordTypes
- array of grade system record types to
be included in each create operation or an empty list if noneNullArgumentException
- gradeSystemRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createGradeSystems(GradeSystemBatchFormList gradeSystemForms) throws OperationFailedException, PermissionDeniedException
GradeSystems.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.gradeSystemForms
- the grade system formsNullArgumentException
- gradeSystemForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemBatchFormList getGradeSystemFormsForUpdate(IdList gradeSystemIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
gradeSystemIds
- the Ids
of the
GradeSystem
NotFoundException
- a gradeSystemId
is
not foundNullArgumentException
- gradeSystemIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateGradeSystems(GradeSystemBatchFormList gradeSystemForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.gradeSystemForms
- the form containing the elements to be
updatedNullArgumentException
- gradeSystemForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllGradeSystems() throws OperationFailedException, PermissionDeniedException
GradeSystems
in this Gradebook
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteGradeSystems(IdList gradeSystemIds) throws OperationFailedException, PermissionDeniedException
Ids.
gradeSystemIds
- the Ids
of the grade systems to
deleteNullArgumentException
- gradeSystemIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasGradeSystems(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a GradeSystem
for the
purpose of creating compatibility. The primary Id
of
the GradeSystem
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another grade system, it is reassigned to the
given grade system Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeBatchFormList getGradeFormsForCreate(IdList gradeSystemIds, Type[] gradeRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
gradeSystemIds
- a list of grade system Ids
gradeRecordTypes
- array of grade system record types to be
included in each create operation or an empty list if noneNotFoundException
- a gradeSystemId
is
not foundNullArgumentException
- gradeSystemIds
or gradeRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createGrades(GradeBatchFormList gradeForms) throws OperationFailedException, PermissionDeniedException
GradeSystems.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.gradeForms
- the grade formsNullArgumentException
- gradeForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeBatchFormList getGradeFormsForUpdate(IdList gradeIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
gradeIds
- the Ids
of the Grade
NotFoundException
- a gradeId
is not
foundNullArgumentException
- gradeIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateGrades(GradeBatchFormList gradeForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.gradeForms
- the form containing the elements to be updatedNullArgumentException
- gradeForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllGrades() throws OperationFailedException, PermissionDeniedException
Grades
in this Gradebook
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteGrades(IdList gradeIds) throws OperationFailedException, PermissionDeniedException
Ids.
gradeIds
- the Ids
of the grade to deleteNullArgumentException
- gradeIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteGradesForGradeSystem(Id gradeSystemId) throws OperationFailedException, PermissionDeniedException
gradeSystemId
- the Ids
of a grade systemNullArgumentException
- gradeSystemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasGrades(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Grade
for the purpose of
creating compatibility. The primary Id
of the
Grade
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is a
pointer to another grade, it is reassigned to the given grade
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.