Package org.openremote.model.asset

Interface AssetModelResource

@Path("model")
public interface AssetModelResource

Resource for handling model requests and also providing server side validation of Assets

Method Summary

Modifier and Type	Method	Description
AssetDescriptor<?>[]	getAssetDescriptors(RequestParams requestParams, String parentId, String parentType)	Retrieve the asset descriptors AssetDescriptor available in this system or from a GatewayAsset depending on whether or not a * parentId is supplied, if it isn't then this instance is used, if it is and the Asset or one of its' * ancestors resides on a GatewayAsset then that gateway instance is used.
AssetTypeInfo	getAssetInfo(RequestParams requestParams, String parentId, String assetType)	Retrieve the specific AssetTypeInfo of the specified} Asset type available in this system or from a GatewayAsset depending on whether or not a parentId * is supplied, if it isn't then this instance is used, if it is and the Asset or one of its' ancestors resides * on a GatewayAsset then that gateway instance is used.
AssetTypeInfo[]	getAssetInfos(RequestParams requestParams, String parentId, String parentType)	Retrieve the AssetTypeInfo of each Asset type available in this system or from a GatewayAsset depending on whether or not a parentId is supplied, if it isn't then this instance is used, if it is and the Asset or one of its' ancestors resides on a GatewayAsset then that gateway instance is used.
Map<String,MetaItemDescriptor<?>>	getMetaItemDescriptors(RequestParams requestParams, String parentId)	Retrieve meta descriptors MetaItemDescriptor available in this system or from a GatewayAsset depending on whether or not a parentId is supplied, if it isn't then this instance is used, if it is and the Asset or one of its' ancestors resides on a GatewayAsset then that gateway instance is used.
Map<String,ValueDescriptor<?>>	getValueDescriptors(RequestParams requestParams, String parentId)	Retrieve value descriptors ValueDescriptor available in this system or from a GatewayAsset depending on whether or not a parentId is supplied, if it isn't then this instance is used, if it is and the Asset or one of its' ancestors resides on a GatewayAsset then that gateway instance is used.

Method Details

getAssetInfos

@GET
@Path("assetInfos")
@Produces("application/json")
AssetTypeInfo[] getAssetInfos(@BeanParam
 RequestParams requestParams,
 @QueryParam("parentId")
 String parentId,
 @QueryParam("parentType")
 String parentType)

Retrieve the AssetTypeInfo of each Asset type available in this system or from a GatewayAsset depending on whether or not a parentId is supplied, if it isn't then this instance is used, if it is and the Asset or one of its' ancestors resides on a GatewayAsset then that gateway instance is used.

getAssetInfo

@GET
@Path("assetInfo/{assetType}")
@Produces("application/json")
AssetTypeInfo getAssetInfo(@BeanParam
 RequestParams requestParams,
 @QueryParam("parentId")
 String parentId,
 @PathParam("assetType")
 String assetType)

Retrieve the specific AssetTypeInfo of the specified} Asset type available in this system or from a GatewayAsset depending on whether or not a parentId * is supplied, if it isn't then this instance is used, if it is and the Asset or one of its' ancestors resides * on a GatewayAsset then that gateway instance is used.

getAssetDescriptors

@GET
@Path("assetDescriptors")
@Produces("application/json")
AssetDescriptor<?>[] getAssetDescriptors(@BeanParam
 RequestParams requestParams,
 @QueryParam("parentId")
 String parentId,
 @QueryParam("parentType")
 String parentType)

Retrieve the asset descriptors AssetDescriptor available in this system or from a GatewayAsset depending on whether or not a * parentId is supplied, if it isn't then this instance is used, if it is and the Asset or one of its' * ancestors resides on a GatewayAsset then that gateway instance is used.

getValueDescriptors

@GET
@Path("valueDescriptors")
@Produces("application/json")
Map<String,ValueDescriptor<?>> getValueDescriptors(@BeanParam
 RequestParams requestParams,
 @QueryParam("parentId")
 String parentId)

Retrieve value descriptors ValueDescriptor available in this system or from a GatewayAsset depending on whether or not a parentId is supplied, if it isn't then this instance is used, if it is and the Asset or one of its' ancestors resides on a GatewayAsset then that gateway instance is used.

getMetaItemDescriptors

@GET
@Path("metaItemDescriptors")
@Produces("application/json")
Map<String,MetaItemDescriptor<?>> getMetaItemDescriptors(@BeanParam
 RequestParams requestParams,
 @QueryParam("parentId")
 String parentId)

Retrieve meta descriptors MetaItemDescriptor available in this system or from a GatewayAsset depending on whether or not a parentId is supplied, if it isn't then this instance is used, if it is and the Asset or one of its' ancestors resides on a GatewayAsset then that gateway instance is used.