OSID - osid.subscription.PublisherQuery Service Interface Definition

Interface	osid.subscription.PublisherQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching for publishers. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchSubscriptionId
Description	Sets the subscription `Id` for this query to match subscriptions assigned to publishers.
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 publisher.
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 publishers with any subscription.
Parameters	`boolean`	`match`	`true` to match publishers with any subscription, `false` to match publishers 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	matchDispatchId
Description	Sets the dispatch `Id` for this query to match subscriptions assigned to dispatches.
Parameters	`osid.id.Id`	`dispatchId`	a 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	clearDispatchIdTerms
Description	Clears the dispatch `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchQuery
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	getDispatchQuery
Description	Gets the query for a dispatch query. Multiple retrievals produce a nested `OR` term.
Return	`osid.subscription.DispatchQuery`		the dispatch query
Errors	UNIMPLEMENTED		`supportsDispatchQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDispatchQuery()` is `true.`
Method	matchAnyDispatch
Description	Matches publishers with any dispatch.
Parameters	`boolean`	`match`	`true` to match publishers with any dispatch, `false` to match publishers with no dispatches
Compliance	`mandatory`		This method must be implemented.
Method	clearDispatchTerms
Description	Clears the dispatch terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorPublisherId
Description	Sets the publisher `Id` for this query to match publishers that have the specified publisher as an ancestor.
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	clearAncestorPublisherIdTerms
Description	Clears the ancestor publisher `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorPublisherQuery
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	getAncestorPublisherQuery
Description	Gets the query for a publisher. Multiple retrievals produce a nested `OR` term.
Return	`osid.subscription.PublisherQuery`		the publisher query
Errors	UNIMPLEMENTED		`supportsAncestorPublisherQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorPublisherQuery()` is `true.`
Method	matchAnyAncestorPublisher
Description	Matches publishers with any ancestor.
Parameters	`boolean`	`match`	`true` to match publishers with any ancestor, `false` to match root publishers
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorPublisherTerms
Description	Clears the ancestor publisher terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantPublisherId
Description	Sets the publisher `Id` for this query to match publishers that have the specified publisher as a descendant.
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	clearDescendantPublisherIdTerms
Description	Clears the descendant publisher `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantPublisherQuery
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	getDescendantPublisherQuery
Description	Gets the query for a publisher. Multiple retrievals produce a nested `OR` term.
Return	`osid.subscription.PublisherQuery`		the publisher query
Errors	UNIMPLEMENTED		`supportsDescendantPublisherQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantPublisherQuery()` is `true.`
Method	matchAnyDescendantPublisher
Description	Matches publishers with any descendant.
Parameters	`boolean`	`match`	`true` to match publishers with any descendant, `false` to match leaf publishers
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantPublisherTerms
Description	Clears the descendant publisher terms.
Compliance	`mandatory`		This method must be implemented.
Method	getPublisherQueryRecord
Description	Gets the publisher query record corresponding to the given `Publisher` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`publisherRecordType`	a publisher record type
Return	`osid.subscription.records.PublisherQueryRecord`		the publisher query record
Errors	NULL_ARGUMENT		`publisherRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(publisherRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.