Interface AwardEntrySearchSession

All Superinterfaces:

AutoCloseable, AwardEntryQuerySession, Closeable, OsidSession, OsidSession

public interface AwardEntrySearchSession
extends AwardEntryQuerySession

This session provides methods for searching among AwardEntries . The search query is constructed using the AwardEntryQuery .

getAwardEntriesByQuery() is the basic search method and returns a list of AwardEntries . A more advanced search may be performed with getAwardEntriesBySearch() .It accepts an AwardEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAwardEntriesBySearch() returns an AwardEntrySearchResults that can be used to access the resulting AwardEntryList or be used to perform a search within the result set through AwardEntrySearch .

This session defines views that offer differing behaviors for searching.

• federated course catalog view: searches include award entries in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
• isolated course catalog view: searches are restricted to courses in this course catalog

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

Method Summary

Modifier and Type	Method	Description
AwardEntrySearchResults	getAwardEntriesBySearch(AwardEntryQuery awardEntryQuery, AwardEntrySearch awardEntrySearch)	Gets the search results matching the given search query using the given search.
AwardEntryQuery	getAwardEntryQueryFromInspector(AwardEntryQueryInspector awardEntryQueryInspector)	Gets an award entry query from an inspector.
AwardEntrySearch	getAwardEntrySearch()	Gets an award entry search.
AwardEntrySearchOrder	getAwardEntrySearchOrder()	Gets an award entry search order.

Methods inherited from interface AwardEntryQuerySession

canSearchAwardEntries, getAwardEntriesByQuery, getAwardEntryQuery, getCourseCatalog, getCourseCatalogId, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchAwardEntries()	Tests if this user can perform AwardEntry searches.
AwardEntryList	getAwardEntriesByQuery(AwardEntryQuery awardEntryQuery)	Gets a list of AwardEntries matching the given award entry query.
AwardEntryQuery	getAwardEntryQuery()	Gets an award entry query.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	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

getAwardEntrySearch

AwardEntrySearch getAwardEntrySearch()

Gets an award entry search.

Returns:

the award entry search

Compliance:

mandatory - This method must be implemented.

getAwardEntrySearchOrder

AwardEntrySearchOrder getAwardEntrySearchOrder()

Gets an award entry search order. The AwardEntrySearchOrder is supplied to an AwardEntrySearch to specify the ordering of results.

Returns:

the award entry search order

Compliance:

mandatory - This method must be implemented.

getAwardEntriesBySearch

AwardEntrySearchResults getAwardEntriesBySearch(AwardEntryQuery awardEntryQuery,
 AwardEntrySearch awardEntrySearch)
                                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

awardEntryQuery - the award entry query

awardEntrySearch - the award entry search

Returns:

the award entry search results

Throws:

NullArgumentException - awardEntryQuery or awardEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - awardEntryQuery or AwardEntrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAwardEntryQueryFromInspector

AwardEntryQuery getAwardEntryQueryFromInspector(AwardEntryQueryInspector awardEntryQueryInspector)

Gets an award entry query from an inspector. The inspector is available from an AwardEntrySearchResults .

Parameters:

awardEntryQueryInspector - an award entry query inspector

Returns:

the award entry query

Throws:

NullArgumentException - awardEntryQueryInspector is null

UnsupportedException - awardEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.