me.adaptive.arp.api

Class CapabilitiesBridge

java.lang.Object

me.adaptive.arp.api.BaseSystemBridge

me.adaptive.arp.api.CapabilitiesBridge

All Implemented Interfaces:

APIBridge, IAdaptiveRP, IBaseSystem, ICapabilities

public class CapabilitiesBridge
extends BaseSystemBridge
implements ICapabilities, APIBridge

Interface for testing the Capabilities operations Auto-generated implementation of ICapabilities specification.

Field Summary

Fields inherited from class me.adaptive.arp.api.BaseSystemBridge

apiGroup

Constructor Summary

Constructors

Constructor and Description
CapabilitiesBridge(ICapabilities delegate) Constructor with delegate.

Method Summary

Modifier and Type	Method and Description
ICapabilities	getDelegate() Get the delegate implementation.
ICapabilitiesOrientation	getOrientationDefault() Obtains the default orientation of the device/display.
ICapabilitiesOrientation[]	getOrientationsSupported() Provides the device/display orientations supported by the platform.
boolean	hasButtonSupport(ICapabilitiesButton type) Determines whether a specific hardware button is supported for interaction.
boolean	hasCommunicationSupport(ICapabilitiesCommunication type) Determines whether a specific Communication capability is supported by the device.
boolean	hasDataSupport(ICapabilitiesData type) Determines whether a specific Data capability is supported by the device.
boolean	hasMediaSupport(ICapabilitiesMedia type) Determines whether a specific Media capability is supported by the device.
boolean	hasNetSupport(ICapabilitiesNet type) Determines whether a specific Net capability is supported by the device.
boolean	hasNotificationSupport(ICapabilitiesNotification type) Determines whether a specific Notification capability is supported by the device.
boolean	hasOrientationSupport(ICapabilitiesOrientation orientation) Determines whether the device/display supports a given orientation.
boolean	hasSensorSupport(ICapabilitiesSensor type) Determines whether a specific Sensor capability is supported by the device.
APIResponse	invoke(APIRequest request) Invokes the given method specified in the API request object.
void	setDelegate(ICapabilities delegate) Set the delegate implementation.

Methods inherited from class me.adaptive.arp.api.BaseSystemBridge

getAPIGroup, getAPIVersion, getJSONParser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.adaptive.arp.api.IAdaptiveRP

getAPIGroup, getAPIVersion

Constructor Detail

CapabilitiesBridge

public CapabilitiesBridge(ICapabilities delegate)

Constructor with delegate.

Parameters:

delegate - The delegate implementing platform specific functions.

Method Detail

getDelegate

public final ICapabilities getDelegate()

Get the delegate implementation.

Returns:

ICapabilities delegate that manages platform specific functions..

setDelegate

public final void setDelegate(ICapabilities delegate)

Set the delegate implementation.

Parameters:

delegate - The delegate implementing platform specific functions.

getOrientationDefault

public ICapabilitiesOrientation getOrientationDefault()

Obtains the default orientation of the device/display. If no default orientation is available on the platform, this method will return the current orientation. To capture device or display orientation changes please use the IDevice and IDisplay functions and listeners API respectively.

Specified by:

getOrientationDefault in interface ICapabilities

Returns:

The default orientation for the device/display.

Since:

v2.0.5

getOrientationsSupported

public ICapabilitiesOrientation[] getOrientationsSupported()

Provides the device/display orientations supported by the platform. A platform will usually support at least one orientation. This is usually PortaitUp.

Specified by:

getOrientationsSupported in interface ICapabilities

Returns:

The orientations supported by the device/display of the platform.

Since:

v2.0.5

hasButtonSupport

public boolean hasButtonSupport(ICapabilitiesButton type)

Determines whether a specific hardware button is supported for interaction.

Specified by:

hasButtonSupport in interface ICapabilities

Parameters:

type - Type of feature to check.

Returns:

true is supported, false otherwise.

Since:

v2.0

hasCommunicationSupport

public boolean hasCommunicationSupport(ICapabilitiesCommunication type)

Determines whether a specific Communication capability is supported by the device.

Specified by:

hasCommunicationSupport in interface ICapabilities

Parameters:

type - Type of feature to check.

Returns:

true if supported, false otherwise.

Since:

v2.0

hasDataSupport

public boolean hasDataSupport(ICapabilitiesData type)

Determines whether a specific Data capability is supported by the device.

Specified by:

hasDataSupport in interface ICapabilities

Parameters:

type - Type of feature to check.

Returns:

true if supported, false otherwise.

Since:

v2.0

hasMediaSupport

public boolean hasMediaSupport(ICapabilitiesMedia type)

Determines whether a specific Media capability is supported by the device.

Specified by:

hasMediaSupport in interface ICapabilities

Parameters:

type - Type of feature to check.

Returns:

true if supported, false otherwise.

Since:

v2.0

hasNetSupport

public boolean hasNetSupport(ICapabilitiesNet type)

Determines whether a specific Net capability is supported by the device.

Specified by:

hasNetSupport in interface ICapabilities

Parameters:

type - Type of feature to check.

Returns:

true if supported, false otherwise.

Since:

v2.0

hasNotificationSupport

public boolean hasNotificationSupport(ICapabilitiesNotification type)

Determines whether a specific Notification capability is supported by the device.

Specified by:

hasNotificationSupport in interface ICapabilities

Parameters:

type - Type of feature to check.

Returns:

true if supported, false otherwise.

Since:

v2.0

hasOrientationSupport

public boolean hasOrientationSupport(ICapabilitiesOrientation orientation)

Determines whether the device/display supports a given orientation.

Specified by:

hasOrientationSupport in interface ICapabilities

Parameters:

orientation - Orientation type.

Returns:

True if the given orientation is supported, false otherwise.

Since:

v2.0.5

hasSensorSupport

public boolean hasSensorSupport(ICapabilitiesSensor type)

Determines whether a specific Sensor capability is supported by the device.

Specified by:

hasSensorSupport in interface ICapabilities

Parameters:

type - Type of feature to check.

Returns:

true if supported, false otherwise.

Since:

v2.0

invoke

public APIResponse invoke(APIRequest request)

Invokes the given method specified in the API request object.

Specified by:

invoke in interface APIBridge

Overrides:

invoke in class BaseSystemBridge

Parameters:

request - APIRequest object containing method name and parameters.

Returns:

APIResponse with status code, message and JSON response or a JSON null string for void functions. Status code 200 is OK, all others are HTTP standard error conditions.