OSID - osid.course.program.EnrollmentCourseCatalogAssignmentSession Service Interface Definition

Interface	osid.course.program.EnrollmentCourseCatalogAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.course.program.CourseProgramManager`
Used By	`osid.course.program.CourseProgramProxyManager`
Description	This session provides methods to re-assign `Enrollments` to `CourseCatalogs`. An `Enrollment` may appear in multiple `CourseCatalogs` and removing the last reference to an `Enrollment` 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 an `Enrollment` to another `CourseCatalog` is not a copy operation (eg: does not change its `Id`).
Method	canAssignEnrollments
Description	Tests if this user can alter enrollment/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`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignEnrollmentToCourseCatalog
Description	Tests if this user can alter enrollment/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`. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`courseCatalogId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCourseCatalogIds
Description	Gets a list of course catalogs including and under the given course catalog node in which any enrollment can be assigned.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.id.IdList`		list of assignable course catalog `Ids`
Errors	NULL_ARGUMENT		`courseCatalogId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCourseCatalogIdsForEnrollment
Description	Gets a list of course catalogs including and under the given course catalog node in which a specific enrollment can be assigned.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Parameters	`osid.id.Id`	`enrollmentId`	the `Id` of the `Enrollment`
Return	`osid.id.IdList`		list of assignable course catalog `Ids`
Errors	NULL_ARGUMENT		`courseCatalogId` or `enrollmentId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignEnrollmentToCatalog
Description	Adds an existing `Enrollment` to a `CourseCatalog`.
Parameters	`osid.id.Id`	`enrollmentId`	the `Id` of the `Enrollment`
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Errors	ALREADY_EXISTS		`enrollmentId` is already assigned to `courseCatalogId`
	NOT_FOUND		`enrollmentId` or `courseCatalogId` not found
	NULL_ARGUMENT		`enrollmentId` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignEnrollmentFromCourseCatalog
Description	Removes an `Enrollment` from a `CourseCatalog`.
Parameters	`osid.id.Id`	`enrollmentId`	the `Id` of the `Enrollment`
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Errors	NOT_FOUND		`enrollmentId` or `courseCatalogId` not found or `enrollmentId` not assigned to `courseCatalogId`
	NULL_ARGUMENT		`enrollmentId` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignEnrollmeentToCourseCatalog
Description	Moves an `Enrollment` from one `CourseCatalog` to another. Mappings to other `CourseCatalogs` are unaffected.
Parameters	`osid.id.Id`	`enrollmentId`	the `Id` of the `Enrollment`
	`osid.id.Id`	`fromCourseCatalogId`	the `Id` of the current `CourseCatalog`
	`osid.id.Id`	`toCourseCatalogId`	the `Id` of the destination `CourseCatalog`
Errors	ALREADY_EXISTS		`enrollmentId` already assigned to `toCourseCatalogId`
	NOT_FOUND		`enrollmentId, fromCourseCatalogId`, or `toCourseCatalogId` not found or `enrollmentId`, not mapped to `fromCourseCatalogId`
	NULL_ARGUMENT		`enrollmentId, fromCourseCatalogId`, or `toCourseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.