com.oracle.iot.client

Class DeviceModelAction.Argument

java.lang.Object

com.oracle.iot.client.DeviceModelAction.Argument

Enclosing class:

DeviceModelAction

public abstract static class DeviceModelAction.Argument
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Argument()

Method Summary

Modifier and Type	Method and Description
abstract DeviceModelAttribute.Type	getArgType() The data type of the argument to the action.
java.lang.Object	getDefaultValue() Get the default value of the argument as defined by the device model.
abstract java.lang.Number	getLowerBound() For DeviceModelAttribute.Type.NUMBER and DeviceModelAttribute.Type.INTEGER only, give the lower bound of the acceptable range of values for the action's argument.
abstract java.lang.String	getName() Get the argument name.
abstract java.lang.Number	getUpperBound() For DeviceModelAttribute.Type.NUMBER and DeviceModelAttribute.Type.INTEGER only, give the upper bound of the acceptable range of values for the action's argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

Argument

public Argument()

Method Detail

getName

public abstract java.lang.String getName()

Get the argument name.

Returns:

the action name from the device model

getArgType

public abstract DeviceModelAttribute.Type getArgType()

The data type of the argument to the action. If the action does not take an argument, then this method will return null.

Returns:

the action argument's data type, or null

getLowerBound

public abstract java.lang.Number getLowerBound()

For DeviceModelAttribute.Type.NUMBER and DeviceModelAttribute.Type.INTEGER only, give the lower bound of the acceptable range of values for the action's argument. Null is always returned for actions other than NUMBER or INTEGER type.

Returns:

a Number, or null if no lower bound has been set

getUpperBound

public abstract java.lang.Number getUpperBound()

For DeviceModelAttribute.Type.NUMBER and DeviceModelAttribute.Type.INTEGER only, give the upper bound of the acceptable range of values for the action's argument. Null is always returned for actions other than NUMBER or INTEGER type.

Returns:

a Number, or null if no upper bound has been set

getDefaultValue

public java.lang.Object getDefaultValue()

Get the default value of the argument as defined by the device model. If there is no defaultValue for the argument in the device model, then this method will return null. The value null is not a default value.

Returns:

the default value of the attribute, or null if no default is defined