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

Interface	osid.offering.rules.CanonicalUnitProcessorEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.offering.rules.OfferingRulesManager`
Used By	`osid.offering.rules.OfferingRulesProxyManager`
Description	This session creates and removes canonical unit processor enablers. The data for create and update is provided via the `CanonicalUnitProcessorEnablerForm`.
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	canCreateCanonicalUnitProcessorEnabler
Description	Tests if this user can create canonical unit processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CanonicalUnitProcessorEnabler` 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 `CanonicalUnitProcessorEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCanonicalUnitProcessorEnablerWithRecordTypes
Description	Tests if this user can create a single `CanonicalUnitProcessorEnabler` using the desired record types. While `OfferingRulesManager.getCanonicalUnitProcessorEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CanonicalUnitProcessorEnabler`. Providing an empty array tests if a `CanonicalUnitProcessorEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`canonicalUnitProcessorEnablerRecordTypes`	array of canonical unit processor enabler record types
Return	`boolean`		`true` if `CanonicalUnitProcessorEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`canonicalUnitProcessorEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorEnablerFormForCreate
Description	Gets the canonical unit processor enabler form for creating new canonical unit processor enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`canonicalUnitProcessorEnablerRecordTypes`	array of canonical unit processor enabler record types
Return	`osid.offering.rules.CanonicalUnitProcessorEnablerForm`		the canonical unit processor enabler form
Errors	NULL_ARGUMENT		`canonicalUnitProcessorEnablerRecordTypes` 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	createCanonicalUnitProcessorEnabler
Description	Creates a new `CanonicalUnitProcessorEnabler`.
Parameters	`osid.offering.rules.CanonicalUnitProcessorEnablerForm`	`canonicalUnitProcessorEnablerForm`	the form for this `CanonicalUnitProcessorEnabler`
Return	`osid.offering.rules.CanonicalUnitProcessorEnabler`		the new `CanonicalUnitProcessorEnabler`
Errors	ILLEGAL_STATE		`canonicalUnitProcessorEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`canonicalUnitProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitProcessorEnablerForm did not originate from getCanonicalUnitProcessorEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCanonicalUnitProcessorEnablers
Description	Tests if this user can update canonical unit processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CanonicalUnitProcessorEnabler` 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 `CanonicalUnitProcessorEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorEnablerFormForUpdate
Description	Gets the canonical unit processor enabler form for updating an existing canonical unit processor enabler. A new canonical unit processor enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`canonicalUnitProcessorEnablerId`	the `Id` of the `CanonicalUnitProcessorEnabler`
Return	`osid.offering.rules.CanonicalUnitProcessorEnablerForm`		the canonical unit processor enabler form
Errors	NOT_FOUND		`canonicalUnitProcessorEnablerId` is not found
	NULL_ARGUMENT		`canonicalUnitProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCanonicalUnitProcessorEnabler
Description	Updates an existing canonical unit processor enabler.
Parameters	`osid.offering.rules.CanonicalUnitProcessorEnablerForm`	`canonicalUnitProcessorEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`canonicalUnitProcessorEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`canonicalUnitProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitProcessorEnablerForm did not originate from getCanonicalUnitProcessorEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCanonicalUnitProcessorEnablers
Description	Tests if this user can delete canonical unit processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CanonicalUnitProcessorEnabler` 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 `CanonicalUnitProcessorEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCanonicalUnitProcessorEnabler
Description	Deletes a `CanonicalUnitProcessorEnabler`.
Parameters	`osid.id.Id`	`canonicalUnitProcessorEnablerId`	the `Id` of the `CanonicalUnitProcessorEnabler` to remove
Errors	NOT_FOUND		`canonicalUnitProcessorEnablerId` not found
	NULL_ARGUMENT		`canonicalUnitProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCanonicalUnitProcessorEnablerAliases
Description	Tests if this user can manage `Id` aliases for canonical unit processor 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 `CanonicalUnitProcessorEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCanonicalUnitProcessorEnabler
Description	Adds an `Id` to a `CanonicalUnitProcessorEnabler` for the purpose of creating compatibility. The primary `Id` of the `CanonicalUnitProcessorEnabler` 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 processor enabler. it is reassigned to the given canonical unit processor enabler `Id`.
Parameters	`osid.id.Id`	`canonicalUnitProcessorEnablerId`	the `Id` of a `CanonicalUnitProcessorEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`canonicalUnitProcessorEnablerId` not found
	NULL_ARGUMENT		`canonicalUnitProcessorEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.