OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
provisioning package
Version 3.0.0
Release Candidate Preview
| Interface | osid.provisioning.DistributorQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining distributor queries. | ||
| Method | getBrokerIdTerms | ||
| Description |
Gets the broker | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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. | |