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

Interface	osid.subscription.rules.DispatchProcessorEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.subscription.rules.DispatchProcessorEnablerQuerySession`
	`osid.subscription.rules.DispatchProcessorEnablerSearchSession`
	`osid.subscription.rules.DispatchProcessorEnablerSmartPublisherSession`
Description	This is the query for searching dispatch processor enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledDispatchProcessorId
Description	Matches dispatch processor enablers mapped to the dispatch processor.
Parameters	`osid.id.Id`	`dispatchProcessorId`	the dispatch processor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`dispatchProcessorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledDispatchProcessorIdTerms
Description	Clears the dispatch processor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledDispatchProcessorQuery
Description	Tests if a `DispatchProcessorQuery` is available.
Return	`boolean`		`true` if a dispatch processor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledDispatchProcessorQuery
Description	Gets the query for a dispatch processor. Multiple retrievals produce a nested `OR` term.
Return	`osid.subscription.rules.DispatchProcessorQuery`		the dispatch processor query
Errors	UNIMPLEMENTED		`supportsRuledDispatchProcessorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledDispatchProcessorQuery()` is `true`.
Method	matchAnyRuledDispatchProcessor
Description	Matches dispatch processor enablers mapped to any dispatch processor.
Parameters	`boolean`	`match`	`true` for dispatch processor enablers mapped to any dispatch processor, `false` to match dispatch processor enablers mapped to no dispatch processor
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledDispatchProcessorTerms
Description	Clears the dispatch processor enabler 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	getDispatchProcessorEnablerQueryRecord
Description	Gets the dispatch processor enabler query record corresponding to the given `DispatchProcessorEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`dispatchProcessorEnablerRecordType`	a dispatch processor enabler record type
Return	`osid.subscription.rules.records.DispatchProcessorEnablerQueryRecord`		the dispatch processor enabler query record
Errors	NULL_ARGUMENT		`dispatchProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(dispatchProcessorEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.