OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ObjectiveBankSearchSession
Implementsosid.learning.ObjectiveBankQuerySession
Description

This session provides methods for searching among ObjectiveBank objects. The search query is constructed using the ObjectiveBankQuery.

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.

MethodgetObjectiveBankSearch
Description

Gets an objective bank search.

Returnosid.learning.ObjectiveBankSearchan objective bank search
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBankSearchOrder
Description

Gets an objective bank search order. The ObjectiveBankSearchOrder is supplied to a ObjectiveBankSearch to specify the ordering of results.

Returnosid.learning.ObjectiveBankSearchOrderthe objective bank search order
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBanksBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.learning.ObjectiveBankQueryobjectiveBankQuerythe objective bank query
osid.learning.ObjectiveBankSearchobjectiveBankSearchthe objective bank search
Returnosid.learning.ObjectiveBankSearchResultsthe search results
ErrorsNULL_ARGUMENT objectiveBankQuery or objectiveBankSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED objectiveBankQuery or objectiveBankSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBankQueryFromInspector
Description

Gets an objective bank query from an inspector. The inspector is available from an ObjectiveBankSearchResults.

Parametersosid.learning.ObjectiveBankQueryInspectorobjectiveBankQueryInspectoran objective bank query inspector
Returnosid.learning.ObjectiveBankQuerythe objective bank query
ErrorsNULL_ARGUMENT objectiveBankQueryInspector is null
UNSUPPORTED objectiveBankQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.