OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConferralAdminSession
Implementsosid.OsidSession
Description

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

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

The delete operations delete Conferrals. To unmap a Conferral from the current Academy, the ConferralAcademyAssignmentSession should be used. These delete operations attempt to remove the Conferral itself thus removing it from all known Academy catalogs.

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

MethodgetAcademyId
Description

Gets the Academy Id associated with this session.

Returnosid.id.Idthe Academy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAcademy
Description

Gets the Academy associated with this session.

Returnosid.recognition.Academythe academy
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateConferrals
Description

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

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

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

Parametersosid.type.Type[]conferralRecordTypesarray of conferral record types
Returnboolean true if Conferral creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT conferralRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetConferralFormForCreate
Description

Gets the conferral form for creating new conferrals. A new form should be requested for each create transaction.

Parametersosid.id.IdawardIdthe Id for the award
osid.id.IdresourceIdthe Id for the recipient
osid.type.Type[]conferralRecordTypesarray of conferral record types
Returnosid.recognition.ConferralFormthe conferral form
ErrorsNOT_FOUND awardId or resourceId is not found
NULL_ARGUMENT awardId, resourceId, or conferralRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateConferral
Description

Creates a new Conferral.

Parametersosid.recognition.ConferralFormconferralFormthe form for this Conferral
Returnosid.recognition.Conferralthe new Conferral
ErrorsILLEGAL_STATE conferralForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT conferralForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED conferralForm did not originate from getConferralFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateConferrals
Description

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

Returnboolean false if Conferral modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetConferralFormForUpdate
Description

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

Parametersosid.id.IdconferralIdthe Id of the Conferral
Returnosid.recognition.ConferralFormthe conferral form
ErrorsNOT_FOUND conferralId is not found
NULL_ARGUMENT conferralId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateConferral
Description

Updates an existing conferral.

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

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

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

Deletes a Conferral.

Parametersosid.id.IdconferralIdthe Id of the Conferral to remove
ErrorsNOT_FOUND conferralId not found
NULL_ARGUMENT conferralId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageConferralAliases
Description

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

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

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