com.oracle.iot.client

Class DeviceModelAction

java.lang.Object

com.oracle.iot.client.DeviceModelAction

public abstract class DeviceModelAction
extends java.lang.Object

DeviceModelAction is the model of an action in a DeviceModel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceModelAction.Argument

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeviceModelAction()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getAlias() Deprecated. Use getName()
abstract java.util.List<DeviceModelAction.Argument>	getArguments() The data type of the argument to the action.
abstract java.lang.String	getDescription() A human friendly description of the action.
abstract java.lang.String	getName() Get the action name.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceModelAction

protected DeviceModelAction()

Method Detail

getName

public abstract java.lang.String getName()

Get the action name.

Returns:

the action name from the device model

getDescription

public abstract java.lang.String getDescription()

A human friendly description of the action. If the model does not contain a description, this method will return an empty String.

Returns:

the action description, or an empty string

getArguments

public abstract java.util.List<DeviceModelAction.Argument> getArguments()

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

getAlias

@Deprecated
public abstract java.lang.String getAlias()

Deprecated. Use getName()

Returns:

an alternative name for the attribute