OSID - osid.offering.CanonicalUnitCatalogueAssignmentSession Service Interface Definition

Interface	osid.offering.CanonicalUnitCatalogueAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session provides methods to re-assign `CanonicalUnits` to `Catalogues`. A `CanonicalUnit` may map to multiple `Catalogues` and removing the last reference to a `CanonicalUnit` 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 `CanonicalUnit` to another `Catalogue` is not a copy operation (eg: does not change its `Id`).
Method	canAssignCanonicalUnits
Description	Tests if this user can alter canonical unit/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	canAssignCanonicalUnitsToCatalogue
Description	Tests if this user can alter canonical unit/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 assignment 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 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	getAssignableCatalogueIdsForCanonicalUnit
Description	Gets a list of catalogues including and under the given catalogue node in which a specific canonical unit can be assigned.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue`
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit`
Return	`osid.id.IdList`		list of assignable catalogue `Ids`
Errors	NULL_ARGUMENT		`catalogueId` or `canonicalUnitId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignCanonicalUnitToCatalogue
Description	Adds an existing `CanonicalUnit` to a `Catalogue`.
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit`
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue`
Errors	ALREADY_EXISTS		`canonicalUnitId` already assigned to `catalogueId`
	NOT_FOUND		`canonicalUnitId` or `catalogueId` not found
	NULL_ARGUMENT		`canonicalUnitId` or `catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCanonicalUnitFromCatalogue
Description	Removes a `CanonicalUnit` from a `Catalogue`.
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit`
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue`
Errors	NOT_FOUND		`canonicalUnitId` or `catalogueId` not found or `canonicalUnitId` not mapped to `catalogueId`
	NULL_ARGUMENT		`canonicalUnitId` or `catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignCanonicalUnitToCatalogue
Description	Moves a `CanonicalUnit` from one `Catalogue` to another. Mappings to other `Catalogues` are unaffected.
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit`
	`osid.id.Id`	`fromCatalogueId`	the `Id` of the current `Catalogue`
	`osid.id.Id`	`toCatalogueId`	the `Id` of the destination `Catalogue`
Errors	ALREADY_EXISTS		`canonicalUnitId` already assigned to `toCatalogueId`
	NOT_FOUND		`canonicalUnitId, fromCatalogueId`, or `toCatalogueId` not found or `canonicalUnitId` not mapped to `fromCatalogueId`
	NULL_ARGUMENT		`canonicalUnitId, fromCatalogueId`, or `toCatalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.