OSID - osid.course.TermAdminSession Service Interface Definition

Interface	osid.course.TermAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.batch.TermBatchAdminSession`
Used By	`osid.course.CourseManager`
Used By	`osid.course.CourseProxyManager`
Description	This session creates, updates, and deletes `Terms` . 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 `term` , a `TermForm` is requested using `getTermFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `TermForm` 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 `TermForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `TermForm` corresponds to an attempted transaction. For updates, `TermForms` are requested to the `Term` `Id` that is to be updated using `getTermFormForUpdate()` . Similarly, the `TermForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `TermForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Terms` . To unmap a `Term` from the current `CourseCatalog` , the `TermCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `Term` itself thus removing it from all known `CourseCatalog` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateTerms
Description	Tests if this user can create `Terms` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Term` will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Term` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateTermWithRecordTypes
Description	Tests if this user can create a single `Term` using the desired record types. While `CourseManager.getTermRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Term` . Providing an empty array tests if a `Term` can be created with no records.
Parameters	`osid.type.Type[]`	`termRecordTypes`	array of term record types
Return	`boolean`		`true` if `Term` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`termRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTermFormForCreate
Description	Gets the term form for creating new terms. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`termRecordTypes`	array of term record types
Return	`osid.course.TermForm`		the term form
Errors	NULL_ARGUMENT		`termRecordTypes` 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	createTerm
Description	Creates a new `Term` .
Parameters	`osid.course.TermForm`	`termForm`	the form for this `Term`
Return	`osid.course.Term`		the new `Term`
Errors	ILLEGAL_STATE		`termForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`termForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`termForm` did not originate from `getTermFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateTerms
Description	Tests if this user can update `Terms` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Term` will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Term` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTermFormForUpdate
Description	Gets the term form for updating an existing term. A new term form should be requested for each update transaction.
Parameters	`osid.id.Id`	`termId`	the `Id` of the `Term`
Return	`osid.course.TermForm`		the term form
Errors	NOT_FOUND		`termId` is not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateTerm
Description	Updates an existing term.
Parameters	`osid.course.TermForm`	`termForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`termForm` already used in anjupdate transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`termId` or `termForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`termForm` did not originate from `getTermFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteTerms
Description	Tests if this user can delete `Terms` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Term` will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Term` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteTerm
Description	Deletes a `Term` .
Parameters	`osid.id.Id`	`termId`	the `Id` of the `Term` to remove
Errors	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageTermAliases
Description	Tests if this user can manage `Id` aliases for `Terms` . 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 `Term` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasTerm
Description	Adds an `Id` to a `Term` for the purpose of creating compatibility. The primary `Id` of the `Term` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another term, it is reassigned to the given term `Id` .
Parameters	`osid.id.Id`	`termId`	the `Id` of a `Term`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`termId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.