Interface DeviceEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DeviceEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply DeviceEnablers to Devices . A Device with multiple DeviceEnablers means any positive rule evaluation across the enablers result in an active Device .

Method Summary

Modifier and Type	Method	Description
void	assignDeviceEnablerToDevice(Id deviceEnablerId, Id deviceId)	Adds an existing DeviceEnabler to a Device .
boolean	canAssignDeviceEnablers()	Tests if this user can alter device enabler/device mappings.
boolean	canSequenceDeviceEnablers()	Tests if this user can order DeviceEnablers .
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	moveDeviceEnablerAhead(Id deviceEnablerId, Id deviceId, Id referenceId)	Reorders device enablers for a device by moving the specified device enabler in front of a reference device enabler.
void	moveDeviceEnablerBehind(Id deviceEnablerId, Id deviceId, Id referenceId)	Reorders device enablers for a device by moving the specified device enabler behind a reference device enabler.
void	orderDeviceEnablers(Id[] deviceEnablerIds, Id deviceId)	Reorders a set of device enablers for a device.
void	unassignDeviceEnablerFromDevice(Id deviceEnablerId, Id deviceId)	Removes a DeviceEnabler from a Device .

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.

canAssignDeviceEnablers

boolean canAssignDeviceEnablers()

Tests if this user can alter device enabler/device 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.

assignDeviceEnablerToDevice

void assignDeviceEnablerToDevice(Id deviceEnablerId,
 Id deviceId)
                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing DeviceEnabler to a Device .

Parameters:

deviceEnablerId - the Id of the DeviceEnabler

deviceId - the Id of the Device

Throws:

AlreadyExistsException - deviceEnablerId already applied to deviceId

NotFoundException - deviceEnablerId or deviceId not found

NullArgumentException - deviceEnablerId or deviceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignDeviceEnablerFromDevice

void unassignDeviceEnablerFromDevice(Id deviceEnablerId,
 Id deviceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a DeviceEnabler from a Device .

Parameters:

deviceEnablerId - the Id of the DeviceEnabler

deviceId - the Id of the Device

Throws:

NotFoundException - deviceEnablerId or deviceId not found or deviceEnablerId not applied to deviceId

NullArgumentException - deviceEnablerId or deviceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceDeviceEnablers

boolean canSequenceDeviceEnablers()

Tests if this user can order DeviceEnablers . 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 DeviceEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveDeviceEnablerAhead

void moveDeviceEnablerAhead(Id deviceEnablerId,
 Id deviceId,
 Id referenceId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

deviceEnablerId - the Id of a DeviceEnabler

deviceId - the Id of a Device

referenceId - the reference device enabler Id

Throws:

NotFoundException - deviceEnablerId, deviceId , or referenceId not found or, deviceEnablerId or referenceId not related to deviceId

NullArgumentException - deviceEnablerId, deviceId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveDeviceEnablerBehind

void moveDeviceEnablerBehind(Id deviceEnablerId,
 Id deviceId,
 Id referenceId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

deviceEnablerId - the Id of a DeviceEnabler

deviceId - the Id of a Device

referenceId - the reference device enabler Id

Throws:

NotFoundException - deviceEnablerId, deviceId , or referenceId not found or, deviceEnablerId or referenceId not related to deviceId

NullArgumentException - deviceEnablerId, deviceId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderDeviceEnablers

void orderDeviceEnablers(Id[] deviceEnablerIds,
 Id deviceId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of device enablers for a device.

Parameters:

deviceEnablerIds - the Ids for a set of DeviceEnablers

deviceId - the Id of a Device

Throws:

NotFoundException - deviceConstraienrId not found or, a deviceEnablerId not related to deviceId

NullArgumentException - deviceEnablerIds or deviceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.