Interface AcademySearchSession

All Superinterfaces:

AcademyQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AcademySearchSession
extends AcademyQuerySession

This session provides methods for searching Academy objects. The search query is constructed using the AcademyQuery . The academy record Type also specifies the record for the academy query.

getAcademiesByQuery() is the basic search method and returns a list of Academy elements. A more advanced search may be performed with getAcademiesBySearch() .It accepts an AcademySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAcademiesBySearch() returns an AcademySearchResults that can be used to access the resulting AcademyList or be used to perform a search within the result set through AcademySearch .

Academies may have a query record indicated by their respective record types. The query record is accessed via the AcademyQuery . The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
AcademySearchResults	getAcademiesBySearch(AcademyQuery academyQuery, AcademySearch academySearch)	Gets the search results matching the given search.
AcademyQuery	getAcademyQueryFromInspector(AcademyQueryInspector academyQueryInspector)	Gets an academy query from an inspector.
AcademySearch	getAcademySearch()	Gets an academy search.
AcademySearchOrder	getAcademySearchOrder()	Gets an academy search order.

Methods inherited from interface AcademyQuerySession

canSearchAcademies, getAcademiesByQuery, getAcademyQuery

Modifier and Type	Method	Description
boolean	canSearchAcademies()	Tests if this user can perform Academy searches.
AcademyList	getAcademiesByQuery(AcademyQuery academyQuery)	Gets a list of Academies matching the given search.
AcademyQuery	getAcademyQuery()	Gets an academy query.

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.

Method Details

getAcademySearch

AcademySearch getAcademySearch()

Gets an academy search.

Returns:

the academy search

Compliance:

mandatory - This method must be implemented.

getAcademySearchOrder

AcademySearchOrder getAcademySearchOrder()

Gets an academy search order. The AcademySearchOrder is supplied to an AcademySearch to specify the ordering of results.

Returns:

the academy search order

Compliance:

mandatory - This method must be implemented.

getAcademiesBySearch

AcademySearchResults getAcademiesBySearch(AcademyQuery academyQuery,
 AcademySearch academySearch)
                                   throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

academyQuery - the academy query

academySearch - the academy search

Returns:

the academy search results

Throws:

NullArgumentException - academyQuery or academies earch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - academyQuery or academies earch is not of this service

Compliance:

mandatory - This method must be implemented.

getAcademyQueryFromInspector

AcademyQuery getAcademyQueryFromInspector(AcademyQueryInspector academyQueryInspector)

Gets an academy query from an inspector. The inspector is available from an AcademySearchResults .

Parameters:

academyQueryInspector - an academy query inspector

Returns:

the academy query

Throws:

NullArgumentException - academyQueryInspector is null

UnsupportedException - academyQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.