Interface DeviceEnablerSystemSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DeviceEnablerSystemSession
extends OsidSession

This session provides methods to retrieve DeviceEnabler to System mappings. A DeviceEnabler may appear in multiple System objects. Each system 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	canLookupDeviceEnablerSystemMappings()	Tests if this user can perform lookups of device enabler/system mappings.
IdList	getDeviceEnablerIdsBySystem(Id systemId)	Gets the list of DeviceEnablerIds associated with a System .
IdList	getDeviceEnablerIdsBySystems(IdList systemIds)	Gets the list of DeviceEnabler Ids corresponding to a list of Systems .
DeviceEnablerList	getDeviceEnablersBySystem(Id systemId)	Gets the list of device enablers associated with a System .
DeviceEnablerList	getDeviceEnablersBySystems(IdList systemIds)	Gets the list of device enablers corresponding to a list of Systems .
IdList	getSystemIdsByDeviceEnabler(Id deviceEnablerId)	Gets the System Ids mapped to a DeviceEnabler .
SystemList	getSystemsByDeviceEnabler(Id deviceEnablerId)	Gets the Systems mapped to a DeviceEnabler .
void	useComparativeDeviceEnablerSystemView()	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	usePlenaryDeviceEnablerSystemView()	A complete view of the DeviceEnabler and System 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

canLookupDeviceEnablerSystemMappings

boolean canLookupDeviceEnablerSystemMappings()

Tests if this user can perform lookups of device enabler/system 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.

useComparativeDeviceEnablerSystemView

void useComparativeDeviceEnablerSystemView()

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.

usePlenaryDeviceEnablerSystemView

void usePlenaryDeviceEnablerSystemView()

A complete view of the DeviceEnabler and System 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.

getDeviceEnablerIdsBySystem

IdList getDeviceEnablerIdsBySystem(Id systemId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of DeviceEnablerIds associated with a System .

Parameters:

systemId - Id of the System

Returns:

list of related device enabler Ids

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDeviceEnablersBySystem

DeviceEnablerList getDeviceEnablersBySystem(Id systemId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of device enablers associated with a System .

Parameters:

systemId - Id of the System

Returns:

list of related device enablers

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDeviceEnablerIdsBySystems

IdList getDeviceEnablerIdsBySystems(IdList systemIds)
                             throws OperationFailedException,
PermissionDeniedException

Gets the list of DeviceEnabler Ids corresponding to a list of Systems .

Parameters:

systemIds - list of system Ids

Returns:

list of device enabler Ids

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDeviceEnablersBySystems

DeviceEnablerList getDeviceEnablersBySystems(IdList systemIds)
                                      throws OperationFailedException,
PermissionDeniedException

Gets the list of device enablers corresponding to a list of Systems .

Parameters:

systemIds - list of system Ids

Returns:

list of device enablers

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemIdsByDeviceEnabler

IdList getSystemIdsByDeviceEnabler(Id deviceEnablerId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the System Ids mapped to a DeviceEnabler .

Parameters:

deviceEnablerId - Id of a DeviceEnabler

Returns:

list of system Ids

Throws:

NotFoundException - deviceEnablerId is not found

NullArgumentException - deviceEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemsByDeviceEnabler

SystemList getSystemsByDeviceEnabler(Id deviceEnablerId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Systems mapped to a DeviceEnabler .

Parameters:

deviceEnablerId - Id of a DeviceEnabler

Returns:

list of systems

Throws:

NotFoundException - deviceEnablerId is not found

NullArgumentException - deviceEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.