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

Interface	osid.cataloging.rules.CatalogEnablerSmartCatalogSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CatalogEnablerQuery` can be retrieved from this session and mapped to this `Catalog` to create a virtual collection of catalog enablers. The catalog enablers may be sequenced using the `CatalogEnablerSearchOrder` from this session. This `Catalog` has a default query that matches any catalog enabler and a default search order that specifies no sequencing. The queries may be examined using a `CatalogEnablerQueryInspector.` The query may be modified by converting the inspector back to a `CatalogEnablerQuery.`
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	canManageSmartCatalogs
Description	Tests if this user can manage smart catalogs. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart catalog management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablerQuery
Description	Gets a catalog enabler query.
Return	`osid.cataloging.rules.CatalogEnablerQuery`		the catalog enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablerSearchOrder
Description	Gets a catalog enabler search order.
Return	`osid.cataloging.rules.CatalogEnablerSearchOrder`		the catalog enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCatalogEnablerQuery
Description	Applies a catalog enabler query to this catalog.
Parameters	`osid.cataloging.rules.CatalogEnablerQuery`	`catalogEnablerQuery`	the catalog enabler query
Errors	NULL_ARGUMENT		`catalogEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`catalogEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCatalogEnablerQuery
Description	Gets a catalog enabler query inspector for this catalog.
Return	`osid.cataloging.rules.CatalogEnablerQueryInspector`		the catalog enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCatalogEnablerSequencing
Description	Applies a catalog enabler search order to this catalog.
Parameters	`osid.cataloging.rules.CatalogEnablerSearchOrder`	`catalogEnablerSearchOrder`	the catalog enabler search order
Errors	NULL_ARGUMENT		`catalogEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`catalogEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablerQueryFromInspector
Description	Gets a catalog enabler query from an inspector.
Parameters	`osid.cataloging.rules.CatalogEnablerQueryInspector`	`catalogEnablerQueryInspector`	a catalog enabler query inspector
Return	`osid.cataloging.rules.CatalogEnablerQuery`		the catalog enabler query
Errors	NULL_ARGUMENT		`catalogEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`catalogEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.