org.osid.learning

Interface ObjectiveSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ObjectiveQuerySession, OsidSession

public interface ObjectiveSearchSession
extends ObjectiveQuerySession

This session provides methods for searching Objective objects. The search query is constructed using the ObjectiveQuery. The objective record Type also specifies the record for the objective query.

getObjectivesByQuery() is the basic search method and returns a list of Objectives. A more advanced search may be performed with getObjectivesBySearch(). It accepts a ObjectiveSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getObjectivesBySearch() returns an ObjectiveSearchResults that can be used to access the resulting ObjectiveList or be used to perform a search within the result set through ObjectiveSearch.

This session defines views that offer differing behaviors for searching.

• federated objective bank view: searches include objectives in objective banks of which this objective bank is a ancestor in the objective bank hierarchy
• isolated objective bank view: searches are restricted to objectives in this objective bank

Objectives may have a query record indicated by their respective record types. The query record is accessed via the ObjectiveQuery.

Method Summary

Methods

Modifier and Type	Method and Description
ObjectiveQuery	getObjectiveQueryFromInspector(ObjectiveQueryInspector objectiveQueryInspector) Gets an objective query from an inspector.
ObjectiveSearchResults	getObjectivesBySearch(ObjectiveQuery objectiveQuery, ObjectiveSearch objectiveSearch) Gets the search results matching the given search query using the given search.
ObjectiveSearch	getObjectiveSearch() Gets an objective search.
ObjectiveSearchOrder	getObjectiveSearchOrder() Gets a n objective search order.

Methods inherited from interface org.osid.learning.ObjectiveQuerySession

canSearchObjectives, getObjectiveBank, getObjectiveBankId, getObjectiveQuery, getObjectivesByQuery, useFederatedObjectiveBankView, useIsolatedObjectiveBankView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getObjectiveSearch

ObjectiveSearch getObjectiveSearch()

Gets an objective search.

Returns:

the objective search

Compliance:

mandatory - This method must be implemented.

getObjectiveSearchOrder

ObjectiveSearchOrder getObjectiveSearchOrder()

Gets a n objective search order. The ObjectiveSearchOrder is supplied to an ObjectiveSearch to specify the ordering of results.

Returns:

the objective search order

Compliance:

mandatory - This method must be implemented.

getObjectivesBySearch

ObjectiveSearchResults getObjectivesBySearch(ObjectiveQuery objectiveQuery,
                                           ObjectiveSearch objectiveSearch)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

objectiveQuery - the objective search query

objectiveSearch - the objective search

Returns:

the returned search results

Throws:

NullArgumentException - objectiveQuery or objectiveSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - objectiveSearch or objectiveQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getObjectiveQueryFromInspector

ObjectiveQuery getObjectiveQueryFromInspector(ObjectiveQueryInspector objectiveQueryInspector)

Gets an objective query from an inspector. The inspector is available from an ObjectiveSearchResults.

Parameters:

objectiveQueryInspector - an objective bank query inspector

Returns:

the objective query

Throws:

NullArgumentException - objectiveQueryInspector is null

UnsupportedException - objectiveQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.