OSID - osid.provisioning.DistributorQueryInspector Service Interface Definition

Interface	osid.provisioning.DistributorQueryInspector
Implements	`osid.OsidCatalogQueryInspector`
Used By	`osid.provisioning.BrokerQueryInspector`
	`osid.provisioning.DistributorQueryInspector`
	`osid.provisioning.DistributorSearchResults`
	`osid.provisioning.PoolQueryInspector`
	`osid.provisioning.ProvisionQueryInspector`
	`osid.provisioning.ProvisionableQueryInspector`
	`osid.provisioning.QueueQueryInspector`
	`osid.provisioning.RequestQueryInspector`
	`osid.provisioning.rules.BrokerConstrainerEnablerQueryInspector`
	`osid.provisioning.rules.BrokerConstrainerQueryInspector`
	show 15 more…
`osid.provisioning.rules.BrokerEnablerQueryInspector`
`osid.provisioning.rules.BrokerProcessorEnablerQueryInspector`
`osid.provisioning.rules.BrokerProcessorQueryInspector`
`osid.provisioning.rules.PoolConstrainerEnablerQueryInspector`
`osid.provisioning.rules.PoolConstrainerQueryInspector`
`osid.provisioning.rules.PoolEnablerQueryInspector`
`osid.provisioning.rules.PoolProcessorEnablerQueryInspector`
`osid.provisioning.rules.PoolProcessorQueryInspector`
`osid.provisioning.rules.ProvisionEnablerQueryInspector`
`osid.provisioning.rules.ProvisionableEnablerQueryInspector`
`osid.provisioning.rules.QueueConstrainerEnablerQueryInspector`
`osid.provisioning.rules.QueueConstrainerQueryInspector`
`osid.provisioning.rules.QueueEnablerQueryInspector`
`osid.provisioning.rules.QueueProcessorEnablerQueryInspector`
`osid.provisioning.rules.QueueProcessorQueryInspector`
Description	This is the query inspector for examining distributor queries. Like all `OsidQueryInspectors`, `DistributorQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getBrokerIdTerms
Description	Gets the broker `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerTerms
Description	Gets the broker query terms.
Return	`osid.provisioning.BrokerQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getQueueIdTerms
Description	Gets the queue `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getQueueTerms
Description	Gets the queue query terms.
Return	`osid.provisioning.QueueQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getPoolIdTerms
Description	Gets the pool `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getPoolTerms
Description	Gets the pool query terms.
Return	`osid.provisioning.PoolQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionIdTerms
Description	Gets the provision `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionTerms
Description	Gets the provision query terms.
Return	`osid.provisioning.ProvisionQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorDistributorIdTerms
Description	Gets the ancestor distributor `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorDistributorTerms
Description	Gets the ancestor distributor query terms.
Return	`osid.provisioning.DistributorQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantDistributorIdTerms
Description	Gets the descendant distributor `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantDistributorTerms
Description	Gets the descendant distributor query terms.
Return	`osid.provisioning.DistributorQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorQueryInspectorRecord
Description	Gets the distributor query inspector record corresponding to the given `Distributor` record `Type`.
Parameters	`osid.type.Type`	`distributorRecordType`	a distributor record type
Return	`osid.provisioning.records.DistributorQueryInspectorRecord`		the distributor query inspector record
Errors	NULL_ARGUMENT		`distributorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(distributorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.