OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
provisioning package
Version 3.0.0
Release Candidate Preview
| Interface | osid.provisioning.RequestQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Description |
This is the query inspector for examining request queries. | ||
| Method | getRequestTransactionIdTerms | ||
| Description |
Gets the request transaction | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequestTransactionTerms | ||
| Description |
Gets the request transaction query terms. | ||
| Return | osid.provisioning.RequestTransactionQueryInspector[] | 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 | getRequestDateTerms | ||
| Description |
Gets the request date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequesterIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequesterTerms | ||
| Description |
Gets the resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequestingAgentIdTerms | ||
| Description |
Gets the agent | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequestingAgentTerms | ||
| Description |
Gets the agent query terms. | ||
| Return | osid.authentication.AgentQueryInspector[] | 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 | getRequestedProvisionableIdTerms | ||
| Description |
Gets the requested provisionable | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequestedProvisionableTerms | ||
| Description |
Gets the requested provisionable query terms. | ||
| Return | osid.provisioning.ProvisionableQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExchangeProvisionIdTerms | ||
| Description |
Gets the exchange provision | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExchangeProvisionTerms | ||
| Description |
Gets the exchange provision query terms. | ||
| Return | osid.provisioning.ProvisionQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOriginProvisionIdTerms | ||
| Description |
Gets the origin provision | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOriginProvisionTerms | ||
| Description |
Gets the origin provision query terms. | ||
| Return | osid.provisioning.ProvisionQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPositionTerms | ||
| Description |
Gets the position query terms. | ||
| Return | osid.search.terms.IntegerRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEWATerms | ||
| Description |
Gets the ewa query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | 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 | getRequestQueryInspectorRecord | ||
| Description |
Gets the request query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | requestRecordType | a request record type |
| Return | osid.provisioning.records.RequestQueryInspectorRecord | the request query inspector record | |
| Errors | NULL_ARGUMENT | requestRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(requestRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |