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

Interface	osid.subscription.rules.DispatchConstrainerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.subscription.rules.DispatchConstrainerEnablerQuerySession`
	`osid.subscription.rules.DispatchConstrainerEnablerSearchSession`
	`osid.subscription.rules.DispatchConstrainerEnablerSmartPublisherSession`
Description	This is the query for searching dispatch constrainer enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchRuledDispatchConstrainerId
Description	Matches dispatch constrainers enabelrs mapped to the dispatch constrainer.
Parameters	`osid.id.Id`	`dispatchConstrainerId`	the dispatch constrainer `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`dispatchConstrainerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledDispatchConstrainerIdTerms
Description	Clears the dispatch constrainer `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledDispatchConstrainerQuery
Description	Tests if a `DispatchConstrainerQuery` is available.
Return	`boolean`		`true` if a dispatch constrainer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledDispatchConstrainerQuery
Description	Gets the query for a dispatch constrainer. Multiple retrievals produce a nested `OR` term.
Return	`osid.subscription.rules.DispatchConstrainerQuery`		the dispatch query
Errors	UNIMPLEMENTED		`supportsRuledDispatchConstrainerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledDispatchConstrainerQuery()` is `true` .
Method	matchAnyRuledDispatchConstrainer
Description	Matches dispatch constrainer enablers mapped to any dispatch constrainer.
Parameters	`boolean`	`match`	`true` for dispatch constrainers enablers mapped to any dispatch constrainer, `false` to match dispatch constrainer enablers mapped to no dispatch constrainers
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledDispatchConstrainerTerms
Description	Clears the dispatch constrainer query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPublisherId
Description	Sets the publisher `Id` for this query to match dispatches assigned to publishers.
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	getDispatchConstrainerEnablerQueryRecord
Description	Gets the dispatch constrainer enabler query record corresponding to the given `DispatchConstrainerEnabler` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`dispatchConstrainerEnablerRecordType`	a dispatch constrainer enabler record type
Return	`osid.subscription.rules.records.DispatchConstrainerEnablerQueryRecord`		the dispatch constrainer enabler query record
Errors	NULL_ARGUMENT		`dispatchConstrainerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(dispatchConstrainerEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.