OSID - osid.offering.CanonicalUnitAdminSession Service Interface Definition

Interface	osid.offering.CanonicalUnitAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `CanonicalUnits.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `CanonicalUnit,` a `CanonicalUnitForm` is requested using `getCanonicalUnitFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CanonicalUnitForm` 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 `CanonicalUnitForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CanonicalUnitForm` corresponds to an attempted transaction. For updates, `CanonicalUnitForms` are requested to the `CanonicalUnit` `Id` that is to be updated using `getCanonicalUnitFormForUpdate().` Similarly, the `CanonicalUnitForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CanonicalUnitForm` can only be used once for a successful update and cannot be reused. The delete operations delete `CanonicalUnits.` To unmap a `CanonicalUnit` from the current `Catalogue,` the `CanonicalUnitCatalogueAssignmentSession` should be used. These delete operations attempt to remove the `CanonicalUnit` itself thus removing it from all known `Catalogue` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCanonicalUnits
Description	Tests if this user can create canonical units. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CanonicalUnit` 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 `CanonicalUnit` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCanonicalUnitWithRecordTypes
Description	Tests if this user can create a single `CanonicalUnit` using the desired record types. While `OfferingManager.getCanonicalUnitRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CanonicalUnit.` Providing an empty array tests if a `CanonicalUnit` can be created with no records.
Parameters	`osid.type.Type[]`	`canonicalUnitRecordTypes`	array of canonical unit record types
Return	`boolean`		`true` if `CanonicalUnit` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`canonicalUnitRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitFormForCreate
Description	Gets the canonical unit form for creating new canonical units. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`canonicalUnitRecordTypes`	array of canonical unit record types to be included in the create operation or an empty list if none
Return	`osid.offering.CanonicalUnitForm`		the canonical unit form
Errors	NULL_ARGUMENT		`canonicalUnitRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		cannot get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createCanonicalUnit
Description	Creates a new `CanonicalUnit.`
Parameters	`osid.offering.CanonicalUnitForm`	`canonicalUnitForm`	the form for this `CanonicalUnit`
Return	`osid.offering.CanonicalUnit`		the new `CanonicalUnit`
Errors	ILLEGAL_STATE		`canonicalUnitForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`canonicalUnitForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitForm` did not originate from `getCanonicalUnitFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCanonicalUnits
Description	Tests if this user can update canonical units. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CanonicalUnit` 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 `CanonicalUnit` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitFormForUpdate
Description	Gets the canonical unit form for updating an existing canonical unit. A new canonical unit form should be requested for each update transaction.
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit`
Return	`osid.offering.CanonicalUnitForm`		the canonical unit form
Errors	NOT_FOUND		`canonicalUnitId` is not found
	NULL_ARGUMENT		`canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCanonicalUnit
Description	Updates an existing canonical unit.
Parameters	`osid.offering.CanonicalUnitForm`	`canonicalUnitForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`canonicalUnitForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`canonicalUnitForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitForm` did not originate from `getCanonicalUnitFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCanonicalUnits
Description	Tests if this user can delete canonical units. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `CanonicalUnit` 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 `CanonicalUnit` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCanonicalUnit
Description	Deletes a `CanonicalUnit.`
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit` to remove
Errors	NOT_FOUND		`canonicalUnitId` not found
	NULL_ARGUMENT		`canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCanonicalUnitAliases
Description	Tests if this user can manage `Id` aliases for `CanonicalUnits.` 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 `CanonicalUnit` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCanonicalUnit
Description	Adds an `Id` to a `CanonicalUnit` for the purpose of creating compatibility. The primary `Id` of the `CanonicalUnit` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another canonical unit, it is reassigned to the given canonical unit `Id.`
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of a `CanonicalUnit`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`canonicalUnitId` not found
	NULL_ARGUMENT		`canonicalUnitId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.