OSID - osid.subscription.rules.SubscriptionEnablerQuerySession Service Interface Definition

Interface	osid.subscription.rules.SubscriptionEnablerQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `SubscriptionEnabler` objects. The search query is constructed using the `SubscriptionEnablerQuery.` This session defines views that offer differing behaviors for searching. federated publisher view: searches include subscription enablers in publishers of which this publisher is an ancestor in the publisher hierarchy isolated publisher view: searches are restricted to subscription enablers in this publisher Subscription enablers may have a query record indicated by their respective record types. The query record is accessed via the `SubscriptionEnablerQuery.`
Method	getPublisherId
Description	Gets the `Publisher` `Id` associated with this session.
Return	`osid.id.Id`		the `Publisher Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPublisher
Description	Gets the `Publisher` associated with this session.
Return	`osid.subscription.Publisher`		the publisher
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchSubscriptionEnablers
Description	Tests if this user can perform `SubscriptionEnabler` 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	useFederatedPublisherView
Description	Federates the view for methods in this session. A federated view will include subscription enablers in publishers which are children of this publisher in the publisher hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPublisherView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this publisher only.
Compliance	`mandatory`		This method is must be implemented.
Method	getSubscriptionEnablerQuery
Description	Gets a subscription enabler query.
Return	`osid.subscription.rules.SubscriptionEnablerQuery`		the subscription enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablersByQuery
Description	Gets a list of `SubscriptionEnablers` matching the given subscription enabler query.
Parameters	`osid.subscription.rules.SubscriptionEnablerQuery`	`subscriptionEnablerQuery`	the subscription enabler query
Return	`osid.subscription.rules.SubscriptionEnablerList`		the returned `SubscriptionEnablerList`
Errors	NULL_ARGUMENT		`subscriptionEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`subscriptionEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.