org.osid.learning

Interface ProficiencySearchSession

All Superinterfaces:

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

public interface ProficiencySearchSession
extends ProficiencyQuerySession

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

Methods

Modifier and Type	Method and 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 org.osid.learning.ProficiencyQuerySession

canSearchProficiencies, getObjectiveBank, getObjectiveBankId, getProficienciesByQuery, getProficiencyQuery, 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

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.