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

Interface	osid.cataloging.rules.CatalogEnablerQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `CatalogEnabler` objects. The search query is constructed using the `CatalogEnablerQuery.` This session defines views that offer differing behaviors for searching. federated catalog view: searches include catalog enablers in catalogs of which this catalog is an ancestor in the catalog hierarchy isolated catalog view: searches are restricted to catalog enablers in this catalog Catalog enablers may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchCatalogEnablers
Description	Tests if this user can perform `CatalogEnabler` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCatalogView
Description	Federates the view for methods in this session. A federated view will include catalog enablers in catalogs which are children of this broker in the catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this catalog only.
Compliance	`mandatory`		This method is 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	getCatalogEnablersByQuery
Description	Gets a list of `CatalogEnablers` matching the given search.
Parameters	`osid.cataloging.rules.CatalogEnablerQuery`	`catalogEnablerQuery`	the catalog enabler query
Return	`osid.cataloging.rules.CatalogEnablerList`		the returned `CatalogEnablerList`
Errors	NULL_ARGUMENT		`catalogEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`catalogEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.