OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AwardEntryAdminSession
Implementsosid.OsidSession
Description

This session creates, updates, and deletes AwardEntries. 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 an AwardEntry, an AwardEntryForm is requested using getAwardEntryFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned AwardEntryForm 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 AwardEntryForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each AwardEntryForm corresponds to an attempted transaction.

For updates, AwardEntryForms are requested to the AwardEntry Id that is to be updated using getAwardEntryFormForUpdate(). Similarly, the AwardEntryForm has metadata about the data that can be updated and it can perform validation before submitting the update. The AwardEntryForm can only be used once for a successful update and cannot be reused.

The delete operations delete AwardEntries. To unmap an AwardEntryForm from the current CourseCatalog, the AwardEntryCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the AwardEntryForm itself thus removing it from all known CourseCatalog catalogs.

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

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateAwardEntries
Description

Tests if this user can create AwardEntries. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an AwardEntry 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 AwardEntry creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateAwardEntryWithRecordTypes
Description

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

Parametersosid.type.Type[]awardEntryRecordTypesarray of award entry record types
Returnboolean true if AwardEntry creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT awardEntryRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntryFormForCreate
Description

Gets the award entry form for creating new award entries. A new form should be requested for each create transaction.

Parametersosid.id.IdawardIdan award Id
osid.id.IdresourceIda student Id
osid.type.Type[]awardEntryRecordTypesarray of award entry record types
Returnosid.course.chronicle.AwardEntryFormthe award entry form
ErrorsNOT_FOUND awardId or resourceId is not found
NULL_ARGUMENT awardId, resourceId , or awardEntryRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAwardEntry
Description

Creates a new AwardEntry.

Parametersosid.course.chronicle.AwardEntryFormawardEntryFormthe form for this AwardEntry
Returnosid.course.chronicle.AwardEntrythe new AwardEntry
ErrorsILLEGAL_STATE awardEntryForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT awardEntryForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED awardEntryForm did not originate from getAwardEntryFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAwardEntries
Description

Tests if this user can update AwardEntries. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AwardEntry 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 AwardEntry modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntryFormForUpdate
Description

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

Parametersosid.id.IdawardEntryIdthe Id of the AwardEntry
Returnosid.course.chronicle.AwardEntryFormthe award entry form
ErrorsNOT_FOUND awardEntryId is not found
NULL_ARGUMENT awardEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAwardEntry
Description

Updates an existing award entry.

Parametersosid.course.chronicle.AwardEntryFormawardEntryFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE awardEntryForm already used in an update transaction
INVALID_ARGUMENT awardEntryId is not found
NULL_ARGUMENT awardEntryForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED awardEntryForm did not originate from getAwardEntryFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAwardEntries
Description

Tests if this user can delete AwardEntries. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AwardEntry 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 AwardEntry deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteAwardEntry
Description

Deletes an AwardEntry.

Parametersosid.id.IdawardEntryIdthe Id of the AwardEntry to remove
ErrorsNOT_FOUND awardEntryId not found
NULL_ARGUMENT awardEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAwardEntryAliases
Description

Tests if this user can manage Id aliases for AwardEntries. 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 AwardEntry aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAwardEntry
Description

Adds an Id to an AwardEntry for the purpose of creating compatibility. The primary Id of the AwardEntry is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another award entry, it is reassigned to the given award entry Id.

Parametersosid.id.IdawardEntryIdthe Id of an AwardEntry
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is in use as a primary Id
NOT_FOUND awardEntryId not found
NULL_ARGUMENT awardEntryId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.