Interface | osid.provisioning.ProvisionableSearchSession | ||
---|---|---|---|
Implements | osid.provisioning.ProvisionableQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Provisionables may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getProvisionableSearch | ||
Description |
Gets a provisionable search. | ||
Return | osid.provisioning.ProvisionableSearch | the provisionable search | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionableSearchOrder | ||
Description |
Gets a provisionable search order. The | ||
Return | osid.provisioning.ProvisionableSearchOrder | the provisionable search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionablesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.provisioning.ProvisionableQuery | provisionableQuery | the provisionable query |
osid.provisioning.ProvisionableSearch | provisionableSearch | the provisionable search | |
Return | osid.provisioning.ProvisionableSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | provisionableQuery or provisionableSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | provisionableQuery or provisionableSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionableQueryFromInspector | ||
Description |
Gets a provisionable query from an inspector. The
inspector is available from a | ||
Parameters | osid.provisioning.ProvisionableQueryInspector | provisionableQueryInspector | a provisionable query inspector |
Return | osid.provisioning.ProvisionableQuery | the provisionable query | |
Errors | NULL_ARGUMENT | provisionableQueryInspector is null | |
UNSUPPORTED | provisionableQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |