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

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