OSID - osid.subscription.DispatchQuery Service Interface Definition

Interface	osid.subscription.DispatchQuery
Implements	`osid.OsidGovernatorQuery`
Used By	`osid.subscription.DispatchQuerySession`
	`osid.subscription.DispatchSearchSession`
	`osid.subscription.DispatchSmartPublisherSession`
	`osid.subscription.PublisherQuery`
	`osid.subscription.SubscriptionQuery`
	`osid.subscription.rules.DispatchConstrainerQuery`
	`osid.subscription.rules.DispatchEnablerQuery`
	`osid.subscription.rules.DispatchEnablerSmartPublisherSession`
	`osid.subscription.rules.DispatchProcessorQuery`
Description	This is the query for searching for dispatches. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchEditorId
Description	Sets a editor `Id` for this query.
Parameters	`osid.id.Id`	`editorId`	a editor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`editorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEditorIdTerms
Description	Clears the editor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEditorQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a editor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEditorQuery
Description	Gets the query for a editor. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the editor query
Errors	UNIMPLEMENTED		`supportsEditorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEditorQuery()` is `true` .
Method	matchAnyEditor
Description	Matches objects with any editor.
Parameters	`boolean`	`match`	`true` to match objects with any editor, `false` to match objects with no editor
Compliance	`mandatory`		This method must be implemented.
Method	clearEditorTerms
Description	Clears the editor query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAddressGenusType
Description	Matches an address genus `Type` accepted by a dispatch.
Parameters	`osid.type.Type`	`addressGenusType`	an address genus `Type`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`addressGenusType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAddressGenusType
Description	Matches dispatches with any address genus type.
Parameters	`boolean`	`match`	`true` to match dispatches with any addres sgenus type, `false` to match dispatches with no address genus types
Compliance	`mandatory`		This method must be implemented.
Method	clearAddressGenusTypeTerms
Description	Clears the address genus `Type` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSubscriptionId
Description	Sets the subscription `Id` for this query to match subscriptions assigned to dispatches.
Parameters	`osid.id.Id`	`subscriptionId`	a 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	clearSubscriptionIdTerms
Description	Clears the subscription `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionQuery
Description	Tests if a subscription query is available.
Return	`boolean`		`true` if a subscription query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionQuery
Description	Gets the query for a dispatch.
Return	`osid.subscription.SubscriptionQuery`		the subscription query
Errors	UNIMPLEMENTED		`supportsSubscriptionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriptionQuery()` is `true` .
Method	matchAnySubscription
Description	Matches dispatches with any subscription.
Parameters	`boolean`	`match`	`true` to match dispatches with any subscription, `false` to match dispatches with no subscriptions
Compliance	`mandatory`		This method must be implemented.
Method	clearSubscriptionTerms
Description	Clears the subscription terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPublisherId
Description	Sets the dispatch `Id` for this query to match subscriptions assigned to publishers.
Parameters	`osid.id.Id`	`publisherId`	a 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` 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 query. 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 terms.
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchQueryRecord
Description	Gets the dispatch query record corresponding to the given `Dispatch` record `Type` .Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`dispatchRecordType`	a dispatch record type
Return	`osid.subscription.records.DispatchQueryRecord`		the dispatch query record
Errors	NULL_ARGUMENT		`dispatchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(dispatchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.