Interface InstructionEngineSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InstructionEngineSession
extends OsidSession

This session provides methods to retrieve Instruction to Engine instructions. An Instruction 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	canLookupInstructionEngineInstructions()	Tests if this user can perform lookups of instruction/engine mappings.
IdList	getEngineIdsByInstruction(Id instructionId)	Gets the Engine Ids mapped to an Instruction .
EngineList	getEnginesByInstruction(Id instructionId)	Gets the Engines mapped to an Instruction .
IdList	getInstructionIdsByEngine(Id engineId)	Gets the list of Instruction Ids associated with a Engine .
IdList	getInstructionIdsByEngines(IdList engineIds)	Gets the list of Instruction Ids corresponding to a list of Engines .
InstructionList	getInstructionsByEngine(Id engineId)	Gets the list of Instructions associated with a Engine .
InstructionList	getInstructionsByEngines(IdList engineIds)	Gets the list of Instructions corresponding to a list of Engines .
void	useComparativeInstructionEngineView()	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	usePlenaryInstructionEngineView()	A complete view of the Instruction 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

canLookupInstructionEngineInstructions

boolean canLookupInstructionEngineInstructions()

Tests if this user can perform lookups of instruction/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 instructions is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeInstructionEngineView

void useComparativeInstructionEngineView()

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.

usePlenaryInstructionEngineView

void usePlenaryInstructionEngineView()

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

getInstructionIdsByEngine

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

Gets the list of Instruction Ids associated with a Engine .

Parameters:

engineId - Id of the Engine

Returns:

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

getInstructionsByEngine

InstructionList getInstructionsByEngine(Id engineId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Instructions associated with a Engine .

Parameters:

engineId - Id of the Engine

Returns:

list of related instructions

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.

getInstructionIdsByEngines

IdList getInstructionIdsByEngines(IdList engineIds)
                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

engineIds - list of engine Ids

Returns:

list of instruction Ids

Throws:

NullArgumentException - engineIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInstructionsByEngines

InstructionList getInstructionsByEngines(IdList engineIds)
                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

engineIds - list of engine Ids

Returns:

list of instructions

Throws:

NullArgumentException - engineIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEngineIdsByInstruction

IdList getEngineIdsByInstruction(Id instructionId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Engine Ids mapped to an Instruction .

Parameters:

instructionId - Id of an Instruction

Returns:

list of engine Ids

Throws:

NotFoundException - instructionId is not found

NullArgumentException - instructionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnginesByInstruction

EngineList getEnginesByInstruction(Id instructionId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Engines mapped to an Instruction .

Parameters:

instructionId - Id of an Instruction

Returns:

list of engines

Throws:

NotFoundException - instructionId is not found

NullArgumentException - instructionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.