OSID - osid.course.chronicle.ProgramEntryCourseCatalogAssignmentSession Service Interface Definition

Interface	osid.course.chronicle.ProgramEntryCourseCatalogAssignmentSession
Implements	`osid.OsidSession`
Description	This session provides methods to re-assign `ProgramEntries` to `CourseCatalogs.` A `ProgramEntry` may appear in multiple `CourseCatalogs` and removing the last reference to a `ProgramEntry` 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 `ProgramEntry` to another `CourseCatalog` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignProgramEntries
Description	Tests if this user can alter program entry/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	canAssignProgramEntryToCourseCatalog
Description	Tests if this user can alter program entry/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 program entry 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	getAssignableCourseCatalogIdsForProgramEntry
Description	Gets a list of course catalogs including and under the given course catalog node in which a specific program entry can be assigned.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Parameters	`osid.id.Id`	`programEntryId`	the `Id` of the `ProgramEntry`
Return	`osid.id.IdList`		list of assignable course catalog `Ids`
Errors	NULL_ARGUMENT		`courseCatalogId` or `programEntryId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignProgramEntryToCourseCatalog
Description	Adds an existing `ProgramEntry` to a `CourseCatalog.`
Parameters	`osid.id.Id`	`programEntryId`	the `Id` of the `ProgramEntry`
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Errors	ALREADY_EXISTS		`programEntryId` is already assigned to `courseCatalogId`
	NOT_FOUND		`programEntryId` or `courseCatalogId` not found
	NULL_ARGUMENT		`programEntryId` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignProgramEntryFromCourseCatalog
Description	Removes a `ProgramEntry` from a `CourseCatalog.`
Parameters	`osid.id.Id`	`programEntryId`	the `Id` of the `ProgramEntry`
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Errors	NOT_FOUND		`programEntryId` or `courseCatalogId` not found or `programEntryId` not assigned to `courseCatalogId`
	NULL_ARGUMENT		`programEntryId` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignProgramEntryToCourseCatalog
Description	Moves a `ProgramEntry` from one `CourseCatalog` to another. Mappings to other `CourseCatalogs` are unaffected.
Parameters	`osid.id.Id`	`programEntryId`	the `Id` of the `ProgramEntry`
	`osid.id.Id`	`fromCourseCatalogId`	the `Id` of the current `CourseCatalog`
	`osid.id.Id`	`toCourseCatalogId`	the `Id` of the destination `CourseCatalog`
Errors	NOT_FOUND		`programEntryId, fromCourseCatalogId,` or `toCourseCatalogId` not found or `programEntryId` not mapped to `fromCourseCatalogId`
	NULL_ARGUMENT		`programEntryId, fromCourseCatalogId,` or `toCourseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.