Interface AgendaEngineSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AgendaEngineSession
extends OsidSession

This session provides methods to retrieve Agenda to Engine checks. An Agenda may appear in multiple Engine objects. Each engine may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupAgendaEngineMappings()	Tests if this user can perform lookups of agenda/engine checks.
IdList	getAgendaIdsByEngine(Id engineId)	Gets the list of Agenda Ids associated with a Engine .
IdList	getAgendaIdsByEngines(IdList engineIds)	Gets the list of Agenda Ids corresponding to a list of Engines .
AgendaList	getAgendasByEngine(Id engineId)	Gets the list of Agendas associated with a Engine .
AgendaList	getAgendasByEngines(IdList engineIds)	Gets the list of Agenda corresponding to a list of Engines .
IdList	getEngineIdsByAgenda(Id agendaId)	Gets the Engine Ids mapped to an Agenda .
EngineList	getEnginesByAgenda(Id agendaId)	Gets the Engines mapped to an Agenda .
void	useComparativeAgendaEngineView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryAgendaEngineView()	A complete view of the Agenda and Engine returns is desired.

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

canLookupAgendaEngineMappings

boolean canLookupAgendaEngineMappings()

Tests if this user can perform lookups of agenda/engine checks. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAgendaEngineView

void useComparativeAgendaEngineView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryAgendaEngineView

void usePlenaryAgendaEngineView()

A complete view of the Agenda and Engine returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getAgendaIdsByEngine

IdList getAgendaIdsByEngine(Id engineId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Agenda Ids associated with a Engine .

Parameters:

engineId - Id of the Engine

Returns:

list of related agenda Ids

Throws:

NotFoundException - engineId is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAgendasByEngine

AgendaList getAgendasByEngine(Id engineId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Agendas associated with a Engine .

Parameters:

engineId - Id of the Engine

Returns:

list of related agendas

Throws:

NotFoundException - engineId is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAgendaIdsByEngines

IdList getAgendaIdsByEngines(IdList engineIds)
                      throws OperationFailedException,
PermissionDeniedException

Gets the list of Agenda Ids corresponding to a list of Engines .

Parameters:

engineIds - list of engine Ids

Returns:

list of agenda Ids

Throws:

NullArgumentException - engineIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAgendasByEngines

AgendaList getAgendasByEngines(IdList engineIds)
                        throws OperationFailedException,
PermissionDeniedException

Gets the list of Agenda corresponding to a list of Engines .

Parameters:

engineIds - list of engine Ids

Returns:

list of agendas

Throws:

NullArgumentException - engineIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEngineIdsByAgenda

IdList getEngineIdsByAgenda(Id agendaId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Engine Ids mapped to an Agenda .

Parameters:

agendaId - Id of an Agenda

Returns:

list of engines

Throws:

NotFoundException - agendaId is not found

NullArgumentException - agendaId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnginesByAgenda

EngineList getEnginesByAgenda(Id agendaId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Engines mapped to an Agenda .

Parameters:

agendaId - Id of an Agenda

Returns:

list of engines

Throws:

NotFoundException - agendaId is not found

NullArgumentException - agendaId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.