Interface CheckEngineSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CheckEngineSession
extends OsidSession

This session provides methods to retrieve Check to Engine mappings. A Check 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	canLookupCheckEngineMappings()	Tests if this user can perform lookups of hold/engine mappings.
IdList	getCheckIdsByEngine(Id engineId)	Gets the list of Check Ids associated with a Engine .
IdList	getCheckIdsByEngines(IdList engineIds)	Gets the list of Check Ids corresponding to a list of Engines .
CheckList	getChecksByEngine(Id engineId)	Gets the list of Checks associated with a Engine .
CheckList	getChecksByEngines(IdList engineIds)	Gets the list of Check corresponding to a list of Engines .
IdList	getEngineIdsByCheck(Id checkId)	Gets the Engine Ids mapped to a Check .
EngineList	getEnginesByCheck(Id checkId)	Gets the Engines mapped to a Check .
void	useComparativeCheckEngineView()	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	usePlenaryCheckEngineView()	A complete view of the Check 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

canLookupCheckEngineMappings

boolean canLookupCheckEngineMappings()

Tests if this user can perform lookups of hold/engine mappings. 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.

useComparativeCheckEngineView

void useComparativeCheckEngineView()

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.

usePlenaryCheckEngineView

void usePlenaryCheckEngineView()

A complete view of the Check 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.

getCheckIdsByEngine

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

Gets the list of Check Ids associated with a Engine .

Parameters:

engineId - Id of the Engine

Returns:

list of related check 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.

getChecksByEngine

CheckList getChecksByEngine(Id engineId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Checks associated with a Engine .

Parameters:

engineId - Id of the Engine

Returns:

list of related checks

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.

getCheckIdsByEngines

IdList getCheckIdsByEngines(IdList engineIds)
                     throws OperationFailedException,
PermissionDeniedException

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

Parameters:

engineIds - list of engine Ids

Returns:

list of check Ids

Throws:

NullArgumentException - engineIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChecksByEngines

CheckList getChecksByEngines(IdList engineIds)
                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

engineIds - list of engine Ids

Returns:

list of checks

Throws:

NullArgumentException - engineIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEngineIdsByCheck

IdList getEngineIdsByCheck(Id checkId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Engine Ids mapped to a Check .

Parameters:

checkId - Id of a Check

Returns:

list of engines

Throws:

NotFoundException - checkId is not found

NullArgumentException - checkId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnginesByCheck

EngineList getEnginesByCheck(Id checkId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Engines mapped to a Check .

Parameters:

checkId - Id of a Check

Returns:

list of engines

Throws:

NotFoundException - checkId is not found

NullArgumentException - checkId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.