Interface AwardSearchSession

All Superinterfaces:

AutoCloseable, AwardQuerySession, Closeable, OsidSession, OsidSession

public interface AwardSearchSession
extends AwardQuerySession

This session provides methods for searching Awards . The search query is constructed using the AwardQuery . The award record Type also specifies the record for the award query.

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

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

Method Summary

Modifier and Type	Method	Description
AwardQuery	getAwardQueryFromInspector(AwardQueryInspector awardQueryInspector)	Gets an award query from an inspector.
AwardSearchResults	getAwardsBySearch(AwardQuery awardQuery, AwardSearch awardSearch)	Gets the search results matching the given search.
AwardSearch	getAwardSearch()	Gets an award search.
AwardSearchOrder	getAwardSearchOrder()	Gets an award search order.

Methods inherited from interface AwardQuerySession

canSearchAwards, getAcademy, getAcademyId, getAwardQuery, getAwardsByQuery, useFederatedAcademyView, useIsolatedAcademyView

Modifier and Type	Method	Description
boolean	canSearchAwards()	Tests if this user can perform Award searches.
Academy	getAcademy()	Gets the Academy associated with this session.
Id	getAcademyId()	Gets the Academy Id associated with this session.
AwardQuery	getAwardQuery()	Gets an award query.
AwardList	getAwardsByQuery(AwardQuery awardQuery)	Gets a list of Awards matching the given search.
void	useFederatedAcademyView()	Federates the view for methods in this session.
void	useIsolatedAcademyView()	Isolates the view for methods in this session.

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

getAwardSearch

AwardSearch getAwardSearch()

Gets an award search.

Returns:

the award search

Compliance:

mandatory - This method must be implemented.

getAwardSearchOrder

AwardSearchOrder getAwardSearchOrder()

Gets an award search order. The AwardSearchOrder is supplied to an AwardSearch to specify the ordering of results.

Returns:

the award search order

Compliance:

mandatory - This method must be implemented.

getAwardsBySearch

AwardSearchResults getAwardsBySearch(AwardQuery awardQuery,
 AwardSearch awardSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

awardQuery - the award query

awardSearch - the award search

Returns:

the award search results

Throws:

NullArgumentException - awardQuery or awardSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - awardQuery or awardSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAwardQueryFromInspector

AwardQuery getAwardQueryFromInspector(AwardQueryInspector awardQueryInspector)

Gets an award query from an inspector. The inspector is available from an AwardSearchResults .

Parameters:

awardQueryInspector - an award query inspector

Returns:

the academy query

Throws:

NullArgumentException - awardQueryInspector is null

UnsupportedException - awardQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.