org.osid.recognition

Interface AwardSearchSession

All Superinterfaces:

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

public interface AwardSearchSession
extends AwardQuerySession

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

Methods

Modifier and Type	Method and 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 org.osid.recognition.AwardQuerySession

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

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

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.