Interface ObjectiveSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ObjectiveQuerySession, OsidSession, OsidSession

public interface ObjectiveSearchSession
extends ObjectiveQuerySession

This session provides methods for searching Objectives . 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 an 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface ObjectiveQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchObjectives()	Tests if this user can perform Objectives searches.
ObjectiveBank	getObjectiveBank()	Gets the ObjectiveBank associated with this session.
Id	getObjectiveBankId()	Gets the ObjectiveBank Id associated with this session.
ObjectiveQuery	getObjectiveQuery()	Gets an objective query.
ObjectiveList	getObjectivesByQuery(ObjectiveQuery objectiveQuery)	Gets a list of Objectives matching the given objective query.
void	useFederatedObjectiveBankView()	Federates the view for methods in this session.
void	useIsolatedObjectiveBankView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.