OSID - osid.course.CourseCatalogAdminSession Service Interface Definition

Interface	osid.course.CourseCatalogAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.batch.CourseCatalogBatchAdminSession`
Used By	`osid.course.CourseManager`
Used By	`osid.course.CourseProxyManager`
Description	This session creates, updates, and deletes `CourseCatalogs`. The data for create and update is provided by the consumer via the form. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `CourseCatalog`, a `CourseCatalogForm` is requested using `getCourseCatalogFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CourseCatalogForm` 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 `CourseCatalogForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CourseCatalogForm` corresponds to an attempted transaction. For updates, `CourseCatalogForms` are requested to the `CourseCatalog` `Id` that is to be updated using `getCourseCatalogFormForUpdate()`. Similarly, the `CourseCatalogForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CourseCatalogForm` can only be used once for a successful update and cannot be reused. The delete operations delete `CourseCatalogs`. It is safer to remove all mappings to the `CourseCatalog` catalogs before deletion. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateCourseCatalogs
Description	Tests if this user can create `CourseCatalogs`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CourseCatalog`. 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.
Return	`boolean`		`false` if `CourseCatalog` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCourseCatalogWithRecordTypes
Description	Tests if this user can create a single `CourseCatalog` using the desired record types. While `CourseManager.getCourseCatalogRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CourseCatalog`. Providing an empty array tests if a `CourseCatalog` can be created with no records.
Parameters	`osid.type.Type[]`	`courseCatalogRecordTypes`	array of course catalog record types
Return	`boolean`		`true` if `CourseCatalog` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseCatalogRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogFormForCreate
Description	Gets the course catalog form for creating new course catalogs. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`courseCatalogRecordTypes`	array of course catalog record types
Return	`osid.course.CourseCatalogForm`		the course catalog form
Errors	NULL_ARGUMENT		`courseCatalogRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createCourseCatalog
Description	Creates a new `CourseCatalog`.
Parameters	`osid.course.CourseCatalogForm`	`courseCatalogForm`	the form for this `CourseCatalog`
Return	`osid.course.CourseCatalog`		the new `CourseCatalog`
Errors	ILLEGAL_STATE		`courseCatalogForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`courseCatalogForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseCatalogForm` did not originate from `getCourseCatalogFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCourseCatalogs
Description	Tests if this user can update `CourseCatalogs`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CourseCatalog` 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.
Return	`boolean`		`false` if `CourseCatalog` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogFormForUpdate
Description	Gets the course catalog form for updating an existing course catalog. A new course catalog form should be requested for each update transaction.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.CourseCatalogForm`		the course catalog form
Errors	NOT_FOUND		`courseCatalogId` is not found
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCourseCatalog
Description	Updates an existing course catalog.
Parameters	`osid.course.CourseCatalogForm`	`courseCatalogForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`courseCatalogForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`courseCatalogForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseCatalogForm` did not originate from `getCourseCatalogFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCourseCatalogs
Description	Tests if this user can delete `CourseCatalogs`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CourseCatalog` 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.
Return	`boolean`		`false` if `CourseCatalog` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCourseCatalog
Description	Deletes a `CourseCatalog`.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog` to remove
Errors	NOT_FOUND		`courseCatalogId` not found
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCourseCatalogAliases
Description	Tests if this user can manage `Id` aliases for `CourseCatalogs`. 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.
Return	`boolean`		`false` if `CourseCatalog` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCourseCatalog
Description	Adds an `Id` to a `CourseCatalog` for the purpose of creating compatibility. The primary `Id` of the `CourseCatalog` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another course catalog, it is reassigned to the given course catalog `Id`.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of a `CourseCatalog`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`aliasId` is in use as a primary `Id`
	NULL_ARGUMENT		`courseCatalogId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.