OSID - osid.offering.rules.CanonicalUnitEnablerAdminSession Service Interface Definition

Interface	osid.offering.rules.CanonicalUnitEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes canonical unit enablers. The data for create and update is provided via the `CanonicalUnitEnablerForm.`
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	canCreateCanonicalUnitEnabler
Description	Tests if this user can create canonical unit enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CanonicalUnitEnabler` 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 `CanonicalUnitEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCanonicalUnitEnablerWithRecordTypes
Description	Tests if this user can create a single `CanonicalUnitEnabler` using the desired record types. While `OfferingRulesManager.getCanonicalUnitEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CanonicalUnitEnabler.` Providing an empty array tests if a `CanonicalUnitEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`canonicalUnitEnablerRecordTypes`	array of canonical unit enabler record types
Return	`boolean`		`true` if `CanonicalUnitEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`canonicalUnitEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablerFormForCreate
Description	Gets the canonical unit enabler form for creating new canonical unit enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`canonicalUnitEnablerRecordTypes`	array of canonical unit enabler record types
Return	`osid.offering.rules.CanonicalUnitEnablerForm`		the canonical unit enabler form
Errors	NULL_ARGUMENT		`canonicalUnitEnablerRecordTypes` 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	createCanonicalUnitEnabler
Description	Creates a new `CanonicalUnitEnabler.`
Parameters	`osid.offering.rules.CanonicalUnitEnablerForm`	`canonicalUnitEnablerForm`	the form for this `CanonicalUnitEnabler`
Return	`osid.offering.rules.CanonicalUnitEnabler`		the new `CanonicalUnitEnabler`
Errors	ILLEGAL_STATE		`canonicalUnitEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`canonicalUnitEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitEnablerForm did not originate from getCanonicalUnitEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCanonicalUnitEnablers
Description	Tests if this user can update canonical unit enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CanonicalUnitEnabler` 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 `CanonicalUnitEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablerFormForUpdate
Description	Gets the canonical unit enabler form for updating an existing canonical unit enabler. A new canonical unit enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of the `CanonicalUnitEnabler`
Return	`osid.offering.rules.CanonicalUnitEnablerForm`		the canonical unit enabler form
Errors	NOT_FOUND		`canonicalUnitEnablerId` is not found
	NULL_ARGUMENT		`canonicalUnitEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCanonicalUnitEnabler
Description	Updates an existing canonical unit enabler.
Parameters	`osid.offering.rules.CanonicalUnitEnablerForm`	`canonicalUnitEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`canonicalUnitEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`canonicalUnitEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitEnablerForm` did not originate from `getCanonicalUnitEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCanonicalUnitEnablers
Description	Tests if this user can delete canonical unit enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CanonicalUnitEnabler` 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 `CanonicalUnitEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCanonicalUnitEnabler
Description	Deletes a `CanonicalUnitEnabler.`
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of the `CanonicalUnitEnabler` to remove
Errors	NOT_FOUND		`canonicalUnitEnablerId` not found
	NULL_ARGUMENT		`canonicalUnitEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCanonicalUnitEnablerAliases
Description	Tests if this user can manage `Id` aliases for canonical unit enablers. 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 `CanonicalUnitEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCanonicalUnitEnabler
Description	Adds an `Id` to a `CanonicalUnitEnabler` for the purpose of creating compatibility. The primary `Id` of the `CanonicalUnitEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another canonical unit enabler. it is reassigned to the given canonical unit enabler `Id.`
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of a `CanonicalUnitEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`canonicalUnitEnablerId` not found
	NULL_ARGUMENT		`canonicalUnitEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.