OSID Logo
OSID Specifications
course registration package
Version 3.1.0
Interfaceosid.course.registration.RegistrationTargetCourseCatalogAssignmentSession
Implementsosid.OsidSession
Used Byosid.course.registration.CourseRegistrationManager
osid.course.registration.CourseRegistrationProxyManager
Description

This session provides methods to re-assign RegistrationTa rgets to CourseCatalog mappings. A RegistrationT arget may appear in multiple CourseCatalog catalogs and removing the last reference to a RegistrationT arget is the equivalent of deleting it. Each CourseCatalog may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a RegistrationT arget to another CourseCatalog is not a copy operation (eg: does not change its Id).

MethodcanAssignRegistrationTargets
Description

Tests if this user can alter registration target/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignRegistrationTargetToCourseCatalog
Description

Tests if this user can alter registration target/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdcourseCatalogId the Id of the CourseCatalog
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT courseCatalogId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableCourseCatalogIds
Description

Gets a list of course catalogs including and under the given course catalog node in which any registration target can be assigned.

Parametersosid.id.IdcourseCatalogId the Id of the CourseCatalog
Returnosid.id.IdList list of assignable course catalog Ids
ErrorsNULL_ARGUMENT courseCatalogId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableCourseCatalogIdsForRegistrationTarget
Description

Gets a list of course catalogs including and under the given course catalog node in which a specific registration target can be assigned.

Parametersosid.id.IdcourseCatalogId the Id of the CourseCatalog
osid.id.IdregistrationTargetId the Id of the RegistrationTarget
Returnosid.id.IdList list of assignable course catalog Ids
ErrorsNULL_ARGUMENT courseCatalogId or registrationTargetId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignRegistrationTargetToCourseCatalog
Description

Adds an existing RegistrationTarget to a CourseCatalog.

Parametersosid.id.IdregistrationTargetId the Id of the RegistrationTarget
osid.id.IdcourseCatalogId the Id of the CourseCatalog
ErrorsALREADY_EXISTS registrationTargetId is already assigned to courseCatalogId
NOT_FOUND registrationTargetId or courseCatalogId not found
NULL_ARGUMENT registrationTargetId or courseCatalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignRegistrationTargetFromCourseCatalog
Description

Removes a RegistrationTarget from a CourseCatalog.

Parametersosid.id.IdregistrationTargetId the Id of the RegistrationTarget
osid.id.IdcourseCatalogId the Id of the CourseCatalog
ErrorsNOT_FOUND registrationTargetId or courseCatalogId not found or registrationTargetId not assigned to courseCatalogId
NULL_ARGUMENT registrationTargetId or courseCatalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignRegistrationTargetToCourseCatalog
Description

Moves a RegistrationTarget from one CourseCatalog to another. Mappings to other CourseCatalogs are unaffected.

Parametersosid.id.IdregistrationTargetId the Id of the RegistrationTarget
osid.id.IdfromCourseCatalogId the Id of the current CourseCatalog
osid.id.IdtoCourseCatalogId the Id of the destination CourseCatalog
ErrorsALREADY_EXISTS registrationTargetId already assigned to tocourseCatalogId
NOT_FOUND registrationTargetId, fromCourseCatalogId, or toCourseCatalogeId not found or registrationTargetId not mapped to fromCourseCatalogId
NULL_ARGUMENT registrationTargetId, fromCourseCatalogId, or toCourseCatalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.