io.relayr.java.model.models

Class DeviceModels

java.lang.Object

io.relayr.java.model.models.DeviceModels

All Implemented Interfaces:

java.io.Serializable

public class DeviceModels
extends java.lang.Object
implements java.io.Serializable

Object that represents all device models supported on relayr platform and a way of navigation through them.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeviceModels()

Method Summary

Modifier and Type	Method and Description
int	getCount() Returns total number of models.
int	getLimit() Returns number of models that can be fetched when paging.
ModelLinks	getLinks() Returns ModelLinks object with hyperlinks to other DeviceModel objects
DeviceModel	getModel(java.lang.String modelId) Returns DeviceModel specified with modelId or DeviceModelsException if io.relayr.java.model with specified id doesn't exist.
java.util.List<DeviceModel>	getModels() Returns all device io.relayr.java.model supported on relayr platform.
int	getOffset() Return offset from the first io.relayr.java.model.
java.util.List<DeviceModel>	getPrototypes() Returns all device io.relayr.java.model supported on relayr platform.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceModels

public DeviceModels()

Method Detail

getLinks

public ModelLinks getLinks()

Returns ModelLinks object with hyperlinks to other DeviceModel objects

Returns:

ModelLinks

getModels

public java.util.List<DeviceModel> getModels()

Returns all device io.relayr.java.model supported on relayr platform.

getPrototypes

public java.util.List<DeviceModel> getPrototypes()

Returns all device io.relayr.java.model supported on relayr platform.

getModel

public DeviceModel getModel(java.lang.String modelId)
                     throws DeviceModelsException

Returns DeviceModel specified with modelId or DeviceModelsException if io.relayr.java.model with specified id doesn't exist.

Returns:

DeviceModel or DeviceModelsException

Throws:

DeviceModelsException

getCount

public int getCount()

Returns total number of models.

getLimit

public int getLimit()

Returns number of models that can be fetched when paging.

getOffset

public int getOffset()

Return offset from the first io.relayr.java.model.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object