OSID - osid.cataloging.rules.CatalogEnablerCatalogAssignmentSession Service Interface Definition

Interface	osid.cataloging.rules.CatalogEnablerCatalogAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.cataloging.rules.CatalogingRulesManager`
Used By	`osid.cataloging.rules.CatalogingRulesProxyManager`
Description	This session provides methods to re-assign `CatalogEnabler` to `Catalog` mappings. A `CatalogEnabler` may appear in multiple `Catalog` objects and removing the last reference to a `CatalogEnabler` is the equivalent of deleting it. Each `Catalog` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `CatalogEnabler` to another `Catalog` is not a copy operation (eg: does not change its `Id`). Like all `OsidSessions`, `CatalogEnablerCatalogAssignmentSessions` are dedicated to single processing threads and a single authenticated user.
Method	canAssignCatalogEnablers
Description	Tests if this user can alter catalog enabler/catalog 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	canAssignCatalogEnablersToCatalog
Description	Tests if this user can alter catalog enabler/catalog 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`	`catalogId`	the `Id` of the `Catalog`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`catalogId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCatalogIds
Description	Gets a list of catalogs including and under the given catalog node in which any catalog enabler can be assigned.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.id.IdList`		list of assignable catalog `Ids`
Errors	NULL_ARGUMENT		`catalogId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCatalogIdsForCatalogEnabler
Description	Gets a list of catalogs including and under the given catalog node in which a specific catalog enabler can be assigned.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of the `CatalogEnabler`
Return	`osid.id.IdList`		list of assignable catalog `Ids`
Errors	NULL_ARGUMENT		`catalogId` or `catalogEnablerId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignCatalogEnablerToCatalog
Description	Adds an existing `CatalogEnabler` to a `Catalog`.
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of the `CatalogEnabler`
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Errors	ALREADY_EXISTS		`catalogEnablerId` is already assigned to `catalogId`
	NOT_FOUND		`catalogEnablerId` or `catalogId` not found
	NULL_ARGUMENT		`catalogEnablerId` or `catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCatalogEnablerFromCatalog
Description	Removes a `CatalogEnabler` from a `Catalog`.
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of the `CatalogEnabler`
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Errors	NOT_FOUND		`catalogEnablerId` or `catalogId` not found or `catalogEnablerId` is not assigned to `catalogId`
	NULL_ARGUMENT		`catalogEnablerId` or `catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignCatalogEnablerToCatalog
Description	Moves a `CatalogEnabler` from one `Catalog` to another. Mappings to other `Catalogs` are unaffected.
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of the `CatalogEnabler`
	`osid.id.Id`	`fromCatalogId`	the `Id` of the current `Catalog`
	`osid.id.Id`	`toCatalogId`	the `Id` of the destination `Catalog`
Errors	ALREADY_EXISTS		`catalogEnablerId` already assigned to `toCatalogId`
	NOT_FOUND		`catalogEnablerId, fromCatalogEnablerId`, or `toCatalogEnablerId` not found or `catalogEnablerId` not mapped to `fromCatalogId`
	NULL_ARGUMENT		`catalogEnablerId, fromCatalogId`, or `toCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.