org.osid.recognition

Interface AwardSmartAcademySession

All Superinterfaces:

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

public interface AwardSmartAcademySession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An AwardQuery can be retrieved from this session and mapped to this Academy to create a virtual collection of Awards. The awards may be sequenced using the AwardSearchOrder from this session.

This Academy has a default query that matches any award and a default search order that specifies no sequencing. The queries may be examined using an AwardQueryInspector. The query may be modified by converting the inspector back to an AwardQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAwardQuery(AwardQuery awardQuery) Applies an award query to this academy.
void	applyAwardSequencing(AwardSearchOrder awardSearchOrder) Applies an award search order to this academy.
boolean	canManageSmartAcademies() Tests if this user can manage smart academies.
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.
AwardQuery	getAwardQueryFromInspector(AwardQueryInspector awardQueryInspector) Gets an award query from an inspector.
AwardSearchOrder	getAwardSearchOrder() Gets an award search order.
AwardQueryInspector	inspectAwardQuery() Gets an award query inspector for this academy.

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 associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartAcademies

boolean canManageSmartAcademies()

Tests if this user can manage smart academies. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart academy management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAwardQuery

AwardQuery getAwardQuery()

Gets an award query.

Returns:

the award query

Compliance:

mandatory - This method must be implemented.

getAwardSearchOrder

AwardSearchOrder getAwardSearchOrder()

Gets an award search order.

Returns:

the award search order

Compliance:

mandatory - This method must be implemented.

applyAwardQuery

void applyAwardQuery(AwardQuery awardQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies an award query to this academy.

Parameters:

awardQuery - the award query

Throws:

NullArgumentException - awardQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - awardQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectAwardQuery

AwardQueryInspector inspectAwardQuery()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets an award query inspector for this academy.

Returns:

the award query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyAwardSequencing

void applyAwardSequencing(AwardSearchOrder awardSearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies an award search order to this academy.

Parameters:

awardSearchOrder - the award search order

Throws:

NullArgumentException - awardSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - awardSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getAwardQueryFromInspector

AwardQuery getAwardQueryFromInspector(AwardQueryInspector awardQueryInspector)

Gets an award query from an inspector.

Parameters:

awardQueryInspector - a query inspector

Returns:

the award query

Throws:

NullArgumentException - awardQueryInspector is null

UnsupportedException - awardQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.