OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradebookColumnAdminSession
Implementsosid.OsidSession
Description

This session creates, updates, and deletes GradebookColumns. 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 GradebookColumn, a GradebookColumnForm is requested using getGradebookColumnFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned GradebookColumnForm 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 the 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.

For updates, GradebookColumnForms are requested to the GradebookColumn Id that is to be updated using getGradebookColumnFormForUpdate(). 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.

The delete operations delete GradebookColumns To unmap a GradebookColumn from the current Gradebook, the GradebookColumnGradebookAssignmentSession should be used. These delete operations attempt to remove the GradebookColumnForm itself thus removing it from all known Gradebook catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

MethodgetGradebookId
Description

Gets the Gradebook Id associated with this session.

Returnosid.id.Idthe Gradebook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetGradebook
Description

Gets the Gradebook associated with this session.

Returnosid.grading.Gradebookthe Gradebook associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateGradebookColumns
Description

Tests if this user can create gradebook columns. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a gradebook column will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if GradebookColumn creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateGradebookColumnWithRecordTypes
Description

Tests if this user can create a single GradebookColumn using the desired record types. While GradingManager.getGradebookColumnRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific GradebookColumn. Providing an empty array tests if a GradebookColumn can be created with no records.

Parametersosid.type.Type[]gradebookColumnRecordTypesarray of gradebook column record types
Returnboolean true if GradebookColumn creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT gradebookColumnRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumnFormForCreate
Description

Gets the gradebook column form for creating new gradebook columns. A new form should be requested for each create transaction.

Parametersosid.type.Type[]gradebookColumnRecordTypesarray of gradebook column record types
Returnosid.grading.GradebookColumnFormthe gradebook column form
ErrorsNULL_ARGUMENT gradebookColumnRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateGradebookColumn
Description

Creates a new GradebookColumn.

Parametersosid.grading.GradebookColumnFormgradebookColumnFormthe form for this GradebookColumn
Returnosid.grading.GradebookColumnthe new GradebookColumn
ErrorsILLEGAL_STATE gradebookColumnForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT gradebookColumnForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED gradebookColumnForm did not originate from getGradebookColumnFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateGradebookColumns
Description

Tests if this user can update gradebook columns. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a GradebookColumn will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if gradebook column modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumnFormForUpdate
Description

Gets the gradebook column form for updating an existing gradebook column. A new gradebook column form should be requested for each update transaction.

Parametersosid.id.IdgradebookColumnIdthe Id of the GradebookColumn
Returnosid.grading.GradebookColumnFormthe gradebook column form
ErrorsNOT_FOUND gradebookColumnId is not found
NULL_ARGUMENT gradebookColumnId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateGradebookColumn
Description

Updates an existing gradebook column.

Parametersosid.grading.GradebookColumnFormgradebookColumnFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE gradebookColumnForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT gradebookColumnForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED gradebookColumnForm did not originate from getGradebookColumnFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodsequenceGradebookColumns
Description

Resequences the gradebook columns.

Parametersosid.id.IdListgradebookColumnIdsthe Ids of the GradebookColumns
ErrorsNULL_ARGUMENT gradebookColumnIdList is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveGradebookColumn
Description

Moves a gradebook column in front of another.

Parametersosid.id.IdfrontGradebookColumnIdthe Id of a GradebookColumn
osid.id.IdbackGradebookColumnIdthe Id of a GradebookColumn
ErrorsNOT_FOUND frontGradebookColumnId or backGradebookColumnId is not found
NULL_ARGUMENT frontGradebookColumnId or backGradebookColumnId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcopyGradebookColumnEntries
Description

Copies gradebook column entries from one column to another. If the target grade column grade system differs from the source, the grades in the entries are transformed to the new grade system.

Parametersosid.id.IdsourceGradebookColumnIdthe Id of a GradebookColumn
osid.id.IdtargetGradebookColumnIdthe Id of a GradebookColumn
ErrorsNOT_FOUND sourceGradebookColumnId ortargetGradebookColumnId is not found
NULL_ARGUMENT sourceGradebookColumnId targetGradebookColumnId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanDeleteGradebookColumns
Description

Tests if this user can delete gradebook columns. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a GradebookColumn will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if GradebookColumn deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteGradebookColumn
Description

Deletes the GradebookColumn identified by the given Id.

Parametersosid.id.IdgradebookColumnIdthe Id of the GradebookColumn to delete
ErrorsNOT_FOUNDa GradebookColumn was not found identified by the given Id
NULL_ARGUMENT gradebookColumnId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageGradebookColumnAliases
Description

Tests if this user can manage Id aliases for GradebookColumns. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if GradebookColumn aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasGradebookColumn
Description

Adds an Id to a GradebookColumn for the purpose of creating compatibility. The primary Id of the GradebookColumn is determined by the provider. The new Id performs as 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.

Parametersosid.id.IdgradebookColumnIdthe Id of a GradebookColumn
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND gradebookColumnId not found
NULL_ARGUMENT gradebookColumnId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.