Interface InputEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InputEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply InputEnablers to Inputs . An Input with multiple InputEnablers means any positive rule evaluation across the enablers result in an effective Input .

Method Summary

Modifier and Type	Method	Description
void	assignInputEnablerToInput(Id inputEnablerId, Id inputId)	Adds an existing InputEnabler to an Input .
boolean	canAssignInputEnablers()	Tests if this user can alter input enabler/input mappings.
boolean	canSequenceInputEnablers()	Tests if this user can order Inputs .
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	moveInputEnablerAhead(Id inputEnablerId, Id inputId, Id referenceId)	Reorders input enablers for an input by moving the specified input enabler in front of a reference input enabler.
void	moveInputEnablerBehind(Id inputEnablerId, Id inputId, Id referenceId)	Reorders input enablers for an input by moving the specified input enabler behind a reference input enabler.
void	orderInputEnablers(Id[] inputEnablerIds, Id inputId)	Reorders a set of input enablers for an input.
void	unassignInputEnablerFromInput(Id inputEnablerId, Id inputId)	Removes an InputEnabler from an Input .

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

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
          throws OperationFailedException,
PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignInputEnablers

boolean canAssignInputEnablers()

Tests if this user can alter input enabler/input mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignInputEnablerToInput

void assignInputEnablerToInput(Id inputEnablerId,
 Id inputId)
                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing InputEnabler to an Input .

Parameters:

inputEnablerId - the Id of the InputEnabler

inputId - the Id of the Input

Throws:

AlreadyExistsException - inputEnablerId already applied to inputId

NotFoundException - inputEnablerId or inputId not found

NullArgumentException - inputEnablerId or inputId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignInputEnablerFromInput

void unassignInputEnablerFromInput(Id inputEnablerId,
 Id inputId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an InputEnabler from an Input .

Parameters:

inputEnablerId - the Id of the InputEnabler

inputId - the Id of the Input

Throws:

NotFoundException - inputEnablerId or inputId not found or not mapped

NullArgumentException - inputEnablerId or inputId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceInputEnablers

boolean canSequenceInputEnablers()

Tests if this user can order Inputs . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if InputEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveInputEnablerAhead

void moveInputEnablerAhead(Id inputEnablerId,
 Id inputId,
 Id referenceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders input enablers for an input by moving the specified input enabler in front of a reference input enabler.

Parameters:

inputEnablerId - the Id of an InputEnabler

inputId - the Id of an Input

referenceId - the reference input Id

Throws:

NotFoundException - inputEnablerId, deviceProcesorId , or referenceId not found or, inputEnablerId or referenceId not related to inputId

NullArgumentException - inputEnablerId, inputId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveInputEnablerBehind

void moveInputEnablerBehind(Id inputEnablerId,
 Id inputId,
 Id referenceId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders input enablers for an input by moving the specified input enabler behind a reference input enabler.

Parameters:

inputEnablerId - the Id of an InputEnabler

inputId - the Id of an Input

referenceId - the reference input Id

Throws:

NotFoundException - inputEnablerId, deviceProcesorId , or referenceId not found or, inputEnablerId or referenceId not related to inputId

NullArgumentException - inputEnablerId, inputId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderInputEnablers

void orderInputEnablers(Id[] inputEnablerIds,
 Id inputId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of input enablers for an input.

Parameters:

inputEnablerIds - the Ids for a set of InputEnablers

inputId - the Id of an Input

Throws:

NotFoundException - inputId not found or, an inputEnablerId not related to inputId

NullArgumentException - inputEnablerIds or inputId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.