OSID Specifications
provisioning package
Version 3.1.0
provisioning package
Version 3.1.0
| Interface | osid.provisioning.ProvisionQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.provisioning.DistributorQueryInspector | ||
osid.provisioning.ProvisionSearchResults | |||
osid.provisioning.ProvisionSmartDistributorSession | |||
osid.provisioning.RequestQueryInspector | |||
osid.provisioning.rules.ProvisionEnablerQueryInspector | |||
| Description |
This is the query inspector for examining provision 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 | getProvisionableIdTerms | ||
| Description |
Gets the provisionable | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionableTerms | ||
| Description |
Gets the provisionable query terms. | ||
| Return | osid.provisioning.ProvisionableQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecipientIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecipientTerms | ||
| Description |
Gets the resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequestIdTerms | ||
| Description |
Gets the request | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequestTerms | ||
| Description |
Gets the request query terms. | ||
| Return | osid.provisioning.RequestQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionDateTerms | ||
| Description |
Gets the provision date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLeasedTerms | ||
| Description |
Gets the leased query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMustReturnTerms | ||
| Description |
Gets the must return query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDueDateTerms | ||
| Description |
Gets the due date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCostTerms | ||
| Description |
Gets the cost query terms. | ||
| Return | osid.search.terms.CurrencyRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRateAmountTerms | ||
| Description |
Gets the rate amount query terms. | ||
| Return | osid.search.terms.CurrencyRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRatePeriodTerms | ||
| Description |
Gets the rate period query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionReturnTerms | ||
| Description |
Gets the provision return query terms. | ||
| Return | osid.provisioning.ProvisionReturnQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDistributorIdTerms | ||
| Description |
Gets the distributor | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDistributorTerms | ||
| Description |
Gets the distributor query terms. | ||
| Return | osid.provisioning.DistributorQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionQueryInspectorRecord | ||
| Description |
Gets the provision query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | provisionRecordType | a provision record type |
| Return | osid.provisioning.records.ProvisionQueryInspectorRecord | the provision query inspector record | |
| Errors | NULL_ARGUMENT | provisionRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(provisionRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |