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

Interface	osid.offering.rules.CanonicalUnitEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `CanonicalUnitEnablers` to `CanonicalUnits.` A `CanonicalUnit` with multiple `CanonicalUnitEnablers` means any positive rule evaluation across the enablers result in an active `CanonicalUnit.`
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	canAssignCanonicalUnitEnablers
Description	Tests if this user can alter canonical unit enabler/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	assignCanonicalUnitEnablerToCanonicalUnit
Description	Adds an existing `CanonicalUnitEnabler` to a `CanonicalUnit.`
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of the `CanonicalUnitEnabler`
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit`
Errors	ALREADY_EXISTS		`canonicalUnitEnablerId` already applied to `canonicalUnitId`
	NOT_FOUND		`canonicalUnitEnablerId` or `canonicalUnitId` not found
	NULL_ARGUMENT		`canonicalUnitEnablerId` or `canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCanonicalUnitEnablerFromCanonicalUnit
Description	Removes a `CanonicalUnitEnabler` from a `CanonicalUnit.`
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of the `CanonicalUnitEnabler`
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit`
Errors	NOT_FOUND		`canonicalUnitEnablerId` or `canonicalUnitId` not found or `canonicalUnitEnablerId` not applied to `canonicalUnitId`
	NULL_ARGUMENT		`canonicalUnitEnablerId` or `canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceCanonicalUnitEnablers
Description	Tests if this user can order `CanonicalUnitEnablers.` 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 `CanonicalUnitEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveCanonicalUnitEnablerAhead
Description	Reorders canonical unit enablers for a canonical unit by moving the specified canonical unit enabler in front of a reference canonical unit enabler.
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of a `CanonicalUnitEnabler`
	`osid.id.Id`	`canonicalUnitId`	the `Id` of a `CanonicalUnit`
	`osid.id.Id`	`referenceId`	the reference canonical unit enabler `Id`
Errors	NOT_FOUND		`canonicalUnitEnablerId, canonicalUnitId,` or `referenceId` not found or, `canonicalUnitEnablerId` or `referenceId` not related to `canonicalUnitId`
	NULL_ARGUMENT		`canonicalUnitEnablerId, canonicalUnitId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveCanonicalUnitEnablerBehind
Description	Reorders canonical unit enablers for a canonical unit by moving the specified canonical unit enabler behind a reference canonical unit enabler.
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of a `CanonicalUnitEnabler`
	`osid.id.Id`	`canonicalUnitId`	the `Id` of a `CanonicalUnit`
	`osid.id.Id`	`referenceId`	the reference canonical unit enabler `Id`
Errors	NOT_FOUND		`canonicalUnitEnablerId, canonicalUnitId,` or `referenceId` not found or, `canonicalUnitEnablerId` or `referenceId` not related to `canonicalUnitId`
	NULL_ARGUMENT		`canonicalUnitEnablerId, canonicalUnitId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderCanonicalUnitEnablers
Description	Reorders a set of canonical unit enablers for a canonical unit.
Parameters	`osid.id.Id[]`	`canonicalUnitEnablerIds`	the `Ids` for a set of `CanonicalUnitEnablers`
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of a `CanonicalUnit`
Errors	NOT_FOUND		`canonicalUnitConstraienrId` not found or, a `canonicalUnitEnablerId` not related to `canonicalUnitId`
	NULL_ARGUMENT		`canonicalUnitEnablerIds` or `canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.