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

Interface	osid.offering.rules.CanonicalUnitProcessorEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.offering.rules.OfferingRulesManager`
Used By	`osid.offering.rules.OfferingRulesProxyManager`
Description	This session provides methods to apply `CanonicalUnitProcessorEnablers` to `CanonicalUnitProcessors`. A `CanonicalUnitProcessor` with multiple `CanonicalUnitProcessorEnablers` means any positive rule evaluation across the enablers result in an effective `CanonicalUnitProcessor`.
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	canAssignCanonicalUnitProcessorEnablers
Description	Tests if this user can alter canonical unit processor enabler/canonical unit processor 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	assignCanonicalUnitProcessorEnablerToCanonicalUnitProcessor
Description	Adds an existing `CanonicalUnitProcessorEnabler` to a `CanonicalUnitProcessor`.
Parameters	`osid.id.Id`	`canonicalUnitProcessorEnablerId`	the `Id` of the `CanonicalUnitProcessorEnabler`
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of the `CanonicalUnitProcessor`
Errors	ALREADY_EXISTS		`canonicalUnitProcessorEnablerId` already applied to `canonicalUnitProcessorId`
	NOT_FOUND		`canonicalUnitProcessorEnablerId` or `canonicalUnitProcessorId` not found
	NULL_ARGUMENT		`canonicalUnitProcessorEnablerId` or `canonicalUnitProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCanonicalUnitProcessorEnablerFromCanonicalUnitProcessor
Description	Removes a `CanonicalUnitProcessorEnabler` from a `CanonicalUnitProcessor`.
Parameters	`osid.id.Id`	`canonicalUnitProcessorEnablerId`	the `Id` of the `CanonicalUnitProcessorEnabler`
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of the `CanonicalUnitProcessor`
Errors	NOT_FOUND		`canonicalUnitProcessorEnablerId` or `canonicalUnitProcessorId` not found or not mapped
	NULL_ARGUMENT		`canonicalUnitProcessorEnablerId` or `canonicalUnitProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceCanonicalUnitProcessorEnablers
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 `CanonicalUnitProcessorEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveCanonicalUnitProcessorEnablerAhead
Description	Reorders canonical unit processor enablers for a canonical unit processor by moving the specified canonical unit processor enabler in front of a reference canonical unit processor enabler.
Parameters	`osid.id.Id`	`canonicalUnitProcessorEnablerId`	the `Id` of a `CanonicalUnitProcessorEnabler`
	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of a `CanonicalUnitProcessor`
	`osid.id.Id`	`referenceId`	the reference canonical unit processor `Id`
Errors	NOT_FOUND		`canonicalUnitProcessorEnablerId, canonicalUnitProcesorId`, or `referenceId` not found or, `canonicalUnitProcessorEnablerId` or `referenceId` not related to `canonicalUnitProcessorId`
	NULL_ARGUMENT		`canonicalUnitProcessorEnablerId, canonicalUnitProcessorId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveCanonicalUnitProcessorEnablerBehind
Description	Reorders canonical unit processor enablers for a canonical unit processor by moving the specified canonical unit processor enabler behind a reference canonical unit processor enabler.
Parameters	`osid.id.Id`	`canonicalUnitProcessorEnablerId`	the `Id` of a `CanonicalUnitProcessorEnabler`
	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of a `CanonicalUnitProcessor`
	`osid.id.Id`	`referenceId`	the reference canonical unit processor `Id`
Errors	NOT_FOUND		`canonicalUnitProcessorEnablerId, canonicalUnitProcesorId`, or `referenceId` not found or, `canonicalUnitProcessorEnablerId` or `referenceId` not related to `canonicalUnitProcessorId`
	NULL_ARGUMENT		`canonicalUnitProcessorEnablerId, canonicalUnitProcessorId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderCanonicalUnitProcessorEnablers
Description	Reorders a set of canonical unit processor enablers for a canonical unit processor.
Parameters	`osid.id.Id[]`	`canonicalUnitProcessorEnablerIds`	the `Ids` for a set of `CanonicalUnitProcessorEnablers`
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of a `CanonicalUnitProcessor`
Errors	NOT_FOUND		`canonicalUnitProcessorId` not found or, a `canonicalUnitProcessorEnablerId` not related to `canonicalUnitProcessorId`
	NULL_ARGUMENT		`canonicalUnitProcessorEnablerIds` or `canonicalUnitProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.