Interface ProficiencySearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ProficiencyQuerySession

public interface ProficiencySearchSession
extends ProficiencyQuerySession

This session provides methods for searching among Proficiencies . The search query is constructed using the ProficiencyQuery .

getProficienciesByQuery() is the basic search method and returns a list of Proficiencies . A more advanced search may be performed with getProficienciesBySearch() .It accepts a ProficiencySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProficienciesBySearch() returns a ProficiencySearchResults that can be used to access the resulting ProficiencyList or be used to perform a search within the result set through ProficiencySearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
ProficiencySearchResults	getProficienciesBySearch(ProficiencyQuery proficiencyQuery, ProficiencySearch proficiencySearch)	Gets the search results matching the given search query using the given search.
ProficiencyQuery	getProficiencyQueryFromInspector(ProficiencyQueryInspector proficiencyQueryInspector)	Gets a proficiency query from an inspector.
ProficiencySearch	getProficiencySearch()	Gets a proficiency search.
ProficiencySearchOrder	getProficiencySearchOrder()	Gets a proficiency search order.

Methods inherited from interface Closeable

close

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.

Methods inherited from interface ProficiencyQuerySession

canSearchProficiencies, getObjectiveBank, getObjectiveBankId, getProficienciesByQuery, getProficiencyQuery, useFederatedObjectiveBankView, useIsolatedObjectiveBankView

Modifier and Type	Method	Description
boolean	canSearchProficiencies()	Tests if this user can perform Proficiency lookups.
ObjectiveBank	getObjectiveBank()	Gets the ObjectiveBank associated with this session.
Id	getObjectiveBankId()	Gets the ObjectiveBank Id associated with this session.
ProficiencyList	getProficienciesByQuery(ProficiencyQuery proficiencyQuery)	Gets a list of Proficiencies matching the given proficiency query.
ProficiencyQuery	getProficiencyQuery()	Gets a proficiency query.
void	useFederatedObjectiveBankView()	Federates the view for methods in this session.
void	useIsolatedObjectiveBankView()	Isolates the view for methods in this session.

Method Details

getProficiencySearch

ProficiencySearch getProficiencySearch()

Gets a proficiency search.

Returns:

the proficiency search

Compliance:

mandatory - This method must be implemented.

getProficiencySearchOrder

ProficiencySearchOrder getProficiencySearchOrder()

Gets a proficiency search order. The ProficiencySearchOrder is supplied to a ProficiencySearch to specify the ordering of results.

Returns:

the proficiency search order

Compliance:

mandatory - This method must be implemented.

getProficienciesBySearch

ProficiencySearchResults getProficienciesBySearch(ProficiencyQuery proficiencyQuery,
 ProficiencySearch proficiencySearch)
                                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

proficiencyQuery - the proficiency query

proficiencySearch - the proficiency search

Returns:

the returned search results

Throws:

NullArgumentException - proficiencyQuery or proficiencySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - proficiencyQuery or proficiencySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProficiencyQueryFromInspector

ProficiencyQuery getProficiencyQueryFromInspector(ProficiencyQueryInspector proficiencyQueryInspector)

Gets a proficiency query from an inspector. The inspector is available from a ProficiencySearchResults .

Parameters:

proficiencyQueryInspector - a proficiency query inspector

Returns:

the proficiency query

Throws:

NullArgumentException - proficiencyQueryInspector is null

UnsupportedException - proficiencyQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.