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

Interface	osid.cataloging.rules.CatalogEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `CatalogEnablers` to `Catalogs.` A `Catalog` with multiple `CatalogEnablers` means any positive rule evaluation across the enablers result in an enabled `Catalog.`
Method	getCatalogId
Description	Gets the `Catalog` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalog
Description	Gets the `Catalog` associated with this session.
Return	`osid.cataloging.Catalog`		the catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
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	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 applied 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 applied 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	canSequenceCatalogEnablers
Description	Tests if this user can order `CatalogEnablers.` 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 `CatalogEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveCatalogEnablerAhead
Description	Reorders catalog enablers for a catalog by moving the specified catalog enabler in front of a reference catalog enabler.
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of a `CatalogEnabler`
	`osid.id.Id`	`catalogId`	the `Id` of a `Catalog`
	`osid.id.Id`	`referenceId`	the reference catalog enabler `Id`
Errors	NOT_FOUND		`catalogEnablerId, catalogId,` or `referenceId` not found or, `catalogEnablerId` or `referenceId` not related to `catalogId`
	NULL_ARGUMENT		`catalogEnablerId, catalogId` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveCatalogEnablerBehind
Description	Reorders catalog enablers for a catalog by moving the specified catalog enabler behind a reference catalog enabler.
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of a `CatalogEnabler`
	`osid.id.Id`	`catalogId`	the `Id` of a `Catalog`
	`osid.id.Id`	`referenceId`	the reference catalog enabler `Id`
Errors	NOT_FOUND		`catalogEnablerId, catalogId,` or `referenceId` not found or, `catalogEnablerId` or `referenceId` not related to `catalogId`
	NULL_ARGUMENT		`catalogEnablerId, catalogId` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderCatalogEnablers
Description	Reorders a set of catalog enablers for a catalog.
Parameters	`osid.id.Id[]`	`catalogEnablerId`	the `Ids` for a set of `CatalogEnablers`
Parameters	`osid.id.Id`	`catalogId`	the `Id` of a `Catalog`
Errors	NOT_FOUND		`catalogId` not found or, a `catalogEnablerId` not related to `catalogId`
	NULL_ARGUMENT		`catalogEnablerIds` or `catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.