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

Interface	osid.offering.rules.CanonicalUnitProcessorRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `CanonicalUnitProcessors` to `CanonicalUnits.`
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	canAssignCanonicalUnitProcessors
Description	Tests if this user can alter canonical unit processor/canonical unit mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignCanonicalUnitProcessorToCanonicalUnit
Description	Adds an existing `CanonicalUnitProcessor` to a `CanonicalUnit.`
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of the `CanonicalUnitProcessor`
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit`
Errors	ALREADY_EXISTS		`canonicalUnitProcessorId` already applied to `canonicalUnitId`
	NOT_FOUND		`canonicalUnitProcessorId` or `canonicalUnitId` not found
	NULL_ARGUMENT		`canonicalUnitProcessorId` or `canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCanonicalUnitProcessorFromCanonicalUnit
Description	Removes a `CanonicalUnitProcessor` from a `CanonicalUnit.`
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of the `CanonicalUnitProcessor`
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit`
Errors	NOT_FOUND		`canonicalUnitProcessorId` or `canonicalUnitId` not found or `canonicalUnitProcessorId` not applied to `canonicalUnitId`
	NULL_ARGUMENT		`canonicalUnitProcessorId` or `canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceCanonicalUnitProcessors
Description	Tests if this user can order `CanonicalUnitProcessors.` A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `CanonicalUnitProcessor` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveCanonicalUnitProcessorAhead
Description	Reorders canonical unit processors for a canonical unit by moving the specified canonical unit processor in front of a reference canonical unit processor.
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of a `CanonicalUnitProcessor`
	`osid.id.Id`	`canonicalUnitId`	the `Id` of a `CanonicalUnit`
	`osid.id.Id`	`referenceId`	the reference canonical unit processor `Id`
Errors	NOT_FOUND		`canonicalUnitProcessorId, canonicalUnitId,` or `referenceId` not found or, `canonicalUnitProcessorId` or `referenceId` not related to `canonicalUnitId`
	NULL_ARGUMENT		`canonicalUnitProcessorId, canonicalUnitId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveCanonicalUnitProcessorBehind
Description	Reorders canonical unit processors for a canonical unit by moving the specified canonical unit processor behind a reference canonical unit processor.
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of a `CanonicalUnitProcessor`
	`osid.id.Id`	`canonicalUnitId`	the `Id` of a `CanonicalUnit`
	`osid.id.Id`	`referenceId`	the reference canonical unit processor `Id`
Errors	NOT_FOUND		`canonicalUnitProcessorId, canonicalUnitId,` or `referenceId` not found or, `canonicalUnitProcessorId` or `referenceId` not related to `canonicalUnitId`
	NULL_ARGUMENT		`canonicalUnitProcessorId, canonicalUnitId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderCanonicalUnitProcessors
Description	Reorders a set of canonical unit processors for a canonical unit.
Parameters	`osid.id.Id[]`	`canonicalUnitProcessorIds`	the `Ids` for a set of `CanonicalUnitProcessors`
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of a `CanonicalUnit`
Errors	NOT_FOUND		`canonicalUnitId` not found or, a `canonicalUnitProcessorId` not related to `canonicalUnitId`
	NULL_ARGUMENT		`canonicalUnitProcessorIds` or `canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.