org.osid.recognition

Interface AwardQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

AwardSearchSession

public interface AwardQuerySession
extends OsidSession

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.

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
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 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

getAcademyId

Id getAcademyId()

Gets the Academy Id associated with this session.

Returns:

the Academy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAcademy

Academy getAcademy()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Academy associated with this session.

Returns:

the academy

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchAwards

boolean canSearchAwards()

Tests if this user can perform Award searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedAcademyView

void useFederatedAcademyView()

Federates the view for methods in this session. A federated view will include awards in academies which are children of this academy in the academy hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedAcademyView

void useIsolatedAcademyView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.

Compliance:

mandatory - This method is must be implemented.

getAwardQuery

AwardQuery getAwardQuery()

Gets an award query.

Returns:

the award query

Compliance:

mandatory - This method must be implemented.

getAwardsByQuery

AwardList getAwardsByQuery(AwardQuery awardQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a list of Awards matching the given search.

Parameters:

awardQuery - the award query

Returns:

the returned AwardList

Throws:

NullArgumentException - awardQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - awardQuery is not of this service

Compliance:

mandatory - This method must be implemented.