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

Interface	osid.subscription.rules.SubscriptionEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.subscription.rules.SubscriptionEnablerQuerySession`
	`osid.subscription.rules.SubscriptionEnablerSearchSession`
	`osid.subscription.rules.SubscriptionEnablerSmartPublisherSession`
Description	This is the query for searching subscription enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledSubscriptionId
Description	Matches enablers mapped to the subscription.
Parameters	`osid.id.Id`	`subscriptionId`	the subscription `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`subscriptionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledSubscriptionIdTerms
Description	Clears the subscription `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledSubscriptionQuery
Description	Tests if a `SubscriptionQuery` is available.
Return	`boolean`		`true` if a subscription query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledSubscriptionQuery
Description	Gets the query for a subscription. Multiple retrievals produce a nested `OR` term.
Return	`osid.subscription.SubscriptionQuery`		the subscription query
Errors	UNIMPLEMENTED		`supportsRuledSubscriptionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledSubscriptionQuery()` is `true`.
Method	matchAnyRuledSubscription
Description	Matches enablers mapped to any subscription.
Parameters	`boolean`	`match`	`true` for enablers mapped to any subscription, `false` to match enablers mapped to no subscription
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledSubscriptionTerms
Description	Clears the subscription query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPublisherId
Description	Matches enablers mapped to the publisher.
Parameters	`osid.id.Id`	`publisherId`	the publisher `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`publisherId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPublisherIdTerms
Description	Clears the publisher `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPublisherQuery
Description	Tests if a `PublisherQuery` is available.
Return	`boolean`		`true` if a publisher query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPublisherQuery
Description	Gets the query for a publisher. Multiple retrievals produce a nested `OR` term.
Return	`osid.subscription.PublisherQuery`		the publisher query
Errors	UNIMPLEMENTED		`supportsPublisherQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPublisherQuery()` is `true`.
Method	clearPublisherTerms
Description	Clears the publisher query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablerQueryRecord
Description	Gets the subscription enabler query record corresponding to the given `SubscriptionEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`subscriptionEnablerRecordType`	a subscription enabler record type
Return	`osid.subscription.rules.records.SubscriptionEnablerQueryRecord`		the subscription enabler query record
Errors	NULL_ARGUMENT		`subscriptionEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(subscriptionEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.