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

Interface	osid.subscription.rules.DispatchProcessorQuery
Implements	`osid.OsidProcessorQuery`
Used By	`osid.subscription.rules.DispatchProcessorEnablerQuery`
	`osid.subscription.rules.DispatchProcessorQuerySession`
	`osid.subscription.rules.DispatchProcessorSearchSession`
	`osid.subscription.rules.DispatchProcessorSmartPublisherSession`
Description	This is the query for searching dispatch processors. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledDispatchId
Description	Matches dispatch processors mapped to the dispatch.
Parameters	`osid.id.Id`	`dispatchId`	the dispatch `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`dispatchId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledDispatchIdTerms
Description	Clears the dispatch `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledDispatchQuery
Description	Tests if a `DispatchQuery` is available.
Return	`boolean`		`true` if a dispatch query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledDispatchQuery
Description	Gets the query for a dispatch. Multiple retrievals produce a nested `OR` term.
Return	`osid.subscription.DispatchQuery`		the dispatch query
Errors	UNIMPLEMENTED		`supportsRuledDispatchQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledDispatchQuery()` is `true`.
Method	matchAnyRuledDispatch
Description	Matches dispatch processors mapped to any dispatch.
Parameters	`boolean`	`match`	`true` for dispatch processors mapped to any dispatch, `false` to match dispatch processors mapped to no dispatch
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledDispatchTerms
Description	Clears the dispatch 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	getDispatchProcessorQueryRecord
Description	Gets the dispatch processor query record corresponding to the given `DispatchProcessor` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`dispatchProcessorRecordType`	a dispatch processor record type
Return	`osid.subscription.rules.records.DispatchProcessorQueryRecord`		the dispatch processor query record
Errors	NULL_ARGUMENT		`dispatchProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(dispatchProcessorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.