Interface ObjectiveBankSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ObjectiveBankQuerySession, OsidSession, OsidSession

public interface ObjectiveBankSearchSession
extends ObjectiveBankQuerySession

This session provides methods for searching among ObjectiveBanks . 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 .

Method Summary

Modifier and Type	Method	Description
ObjectiveBankQuery	getObjectiveBankQueryFromInspector(ObjectiveBankQueryInspector objectiveBankQueryInspector)	Gets an objective bank query from an inspector.
ObjectiveBankSearchResults	getObjectiveBanksBySearch(ObjectiveBankQuery objectiveBankQuery, ObjectiveBankSearch objectiveBankSearch)	Gets the search results matching the given search query using the given search.
ObjectiveBankSearch	getObjectiveBankSearch()	Gets an objective bank search.
ObjectiveBankSearchOrder	getObjectiveBankSearchOrder()	Gets an objective bank search order.

Methods inherited from interface Closeable

close

Methods inherited from interface ObjectiveBankQuerySession

canSearchObjectiveBanks, getObjectiveBankQuery, getObjectiveBanksByQuery

Modifier and Type	Method	Description
boolean	canSearchObjectiveBanks()	Tests if this user can perform ObjectiveBank searches.
ObjectiveBankQuery	getObjectiveBankQuery()	Gets an objective bank query.
ObjectiveBankList	getObjectiveBanksByQuery(ObjectiveBankQuery objectiveBankQuery)	Gets a list of ObjectiveBank objects matching the given objectiove bank query.

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

getObjectiveBankSearch

ObjectiveBankSearch getObjectiveBankSearch()

Gets an objective bank search.

Returns:

an objective bank search

Compliance:

mandatory - This method must be implemented.

getObjectiveBankSearchOrder

ObjectiveBankSearchOrder getObjectiveBankSearchOrder()

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

Returns:

the objective bank search order

Compliance:

mandatory - This method must be implemented.

getObjectiveBanksBySearch

ObjectiveBankSearchResults getObjectiveBanksBySearch(ObjectiveBankQuery objectiveBankQuery,
 ObjectiveBankSearch objectiveBankSearch)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

objectiveBankQuery - the objective bank query

objectiveBankSearch - the objective bank search

Returns:

the search results

Throws:

NullArgumentException - objectiveBankQuery or objectiveBankSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - objectiveBankQuery or objectiveBankSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getObjectiveBankQueryFromInspector

ObjectiveBankQuery getObjectiveBankQueryFromInspector(ObjectiveBankQueryInspector objectiveBankQueryInspector)

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

Parameters:

objectiveBankQueryInspector - an objective bank query inspector

Returns:

the objective bank query

Throws:

NullArgumentException - objectiveBankQueryInspector is null

UnsupportedException - objectiveBankQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.