| Interface | osid.learning.ObjectiveBankSearchSession | ||
|---|---|---|---|
| Implements | osid.learning.ObjectiveBankQuerySession | ||
| Used By | osid.learning.LearningManager | ||
osid.learning.LearningProxyManager | |||
| Description |
This session provides methods for searching among
getObjectiveBanksByQuery() is the basic search
method and returns a list of ObjectiveBank
objects.A more advanced search may be performed with
getObjectiveBanksBySearch(). It accepts a
ObjectiveBankSearch in addition to the query for
the purpose of specifying additional options affecting the
entire search, such as ordering.
getObjectiveBanksBySearch() returns a
ObjectiveBankSearchResults that can be used to
access the resulting ObjectiveBankList or be used
to perform a search within the result set through
ObjectiveBankSearch.
ObjectiveBanks may have a query record indicated
by their respective record types. The query record is accessed
via the ObjectiveBankQuery. | ||
| Method | getObjectiveBankSearch | ||
| Description |
Gets an objective bank search. | ||
| Return | osid.learning.ObjectiveBankSearch | an objective bank search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getObjectiveBankSearchOrder | ||
| Description |
Gets an objective bank search order. The
| ||
| Return | osid.learning.ObjectiveBankSearchOrder | the objective bank search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getObjectiveBanksBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.learning.ObjectiveBankQuery | objectiveBankQuery | the objective bank query |
osid.learning.ObjectiveBankSearch | objectiveBankSearch | the objective bank search | |
| Return | osid.learning.ObjectiveBankSearchResults | the search results | |
| Errors | NULL_ARGUMENT | objectiveBankQuery or objectiveBankSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | objectiveBankQuery or objectiveBankSearch is not
of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getObjectiveBankQueryFromInspector | ||
| Description |
Gets an objective bank query from an inspector. The
inspector is available from an
| ||
| Parameters | osid.learning.ObjectiveBankQueryInspector | objectiveBankQueryInspector | an objective bank query inspector |
| Return | osid.learning.ObjectiveBankQuery | the objective bank query | |
| Errors | NULL_ARGUMENT | objectiveBankQueryInspector is null | |
| UNSUPPORTED | objectiveBankQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |