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

Interface	osid.offering.rules.CanonicalUnitEnablerCatalogueAssignmentSession
Implements	`osid.OsidSession`
Description	This session provides methods to re-assign `CanonicalUnitEnabler` to `Catalogue` mappings. A `CanonicalUnitEnabler` may appear in multiple `Catalogue` objects and removing the last reference to a `CanonicalUnitEnabler` is the equivalent of deleting it. Each `Catalogue` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `CanonicalUnitEnabler` to another `Catalogue` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignCanonicalUnitEnablers
Description	Tests if this user can alter canonical unit enabler/catalogue 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	canAssignCanonicalUnitEnablersToCatalogue
Description	Tests if this user can alter canonical unit enabler/catalogue 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.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`catalogueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCatalogueIds
Description	Gets a list of catalogues including and under the given catalogue node in which any canonical unit enabler can be assigned.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue`
Return	`osid.id.IdList`		list of assignable catalogue `Ids`
Errors	NULL_ARGUMENT		`catalogueId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCatalogueIdsForCanonicalUnitEnabler
Description	Gets a list of catalogues including and under the given catalogue node in which a specific canonical unit enabler can be assigned.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue`
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of the `CanonicalUnitEnabler`
Return	`osid.id.IdList`		list of assignable catalogue `Ids`
Errors	NULL_ARGUMENT		`catalogueId` or `canonicalUnitEnablerId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignCanonicalUnitEnablerToCatalogue
Description	Adds an existing `CanonicalUnitEnabler` to a `Catalogue.`
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of the `CanonicalUnitEnabler`
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue`
Errors	ALREADY_EXISTS		`canonicalUnitEnablerId` already assigned to `catalogueId`
	NOT_FOUND		`canonicalUnitEnablerId` or `catalogueId` not found
	NULL_ARGUMENT		`canonicalUnitEnablerId` or `catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCanonicalUnitEnablerFromCatalogue
Description	Removes a `CanonicalUnitEnabler` from a `Catalogue.`
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of the `CanonicalUnitEnabler`
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue`
Errors	NOT_FOUND		`canonicalUnitEnablerId` or `catalogueId` not found or `canonicalUnitEnablerId` already assigned to `catalogueId`
	NULL_ARGUMENT		`canonicalUnitEnablerId` or `catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignCanonicalUnitEnablerToCatalogue
Description	Moves a `CanonicalUnitEnablerr` from one `Catalogue` to another. Mappings to other `Catalogues` are unaffected.
Parameters	`osid.id.Id`	`canonicalUnitEnablerId`	the `Id` of the `CanonicalUnitEnabler`
	`osid.id.Id`	`fromCatalogueId`	the `Id` of the current `Catalogue`
	`osid.id.Id`	`toCatalogueId`	the `Id` of the destination `Catalogue`
Errors	NOT_FOUND		`canonicalUnitEnablerId, fromCatalogueId,` or `toCatalogueId` not found or `canonicalUnitEnablerId,` not mapped to `fromCatalogueId`
	NULL_ARGUMENT		`canonicalUnitEnablerId, fromCatalogueId,` or `toCatalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.