Package org.openremote.model.alarm

Interface AlarmResource

@Path("alarm")
public interface AlarmResource

Method Summary

Modifier and Type	Method	Description
SentAlarm	createAlarm(RequestParams requestParams, Alarm alarm, List<String> assetIds)
SentAlarm	getAlarm(RequestParams requestParams, Long alarmId)
SentAlarm[]	getAlarms(RequestParams requestParams, String realm, Alarm.Status status, String assetId, String assigneeId)
List<AlarmAssetLink>	getAssetLinks(RequestParams requestParams, Long alarmId, String realm)
void	removeAlarm(RequestParams requestParams, Long alarmId)
void	removeAlarms(RequestParams requestParams, List<Long> ids)
void	setAssetLinks(RequestParams requestParams, List<AlarmAssetLink> links)
void	updateAlarm(RequestParams requestParams, Long alarmId, SentAlarm alarm)

Method Details

getAlarms

@GET
@Produces("application/json")
@RolesAllowed("read:alarms")
SentAlarm[] getAlarms(@BeanParam
 RequestParams requestParams,
 @QueryParam("realm")
 String realm,
 @QueryParam("status")
 Alarm.Status status,
 @QueryParam("assetId")
 String assetId,
 @QueryParam("assigneeId")
 String assigneeId)

createAlarm

@POST
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("write:alarms")
SentAlarm createAlarm(@BeanParam
 RequestParams requestParams,
 Alarm alarm,
 @QueryParam("assetIds")
 List<String> assetIds)

removeAlarms

@DELETE
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("write:alarms")
void removeAlarms(@BeanParam
 RequestParams requestParams,
 List<Long> ids)

getAlarm

@GET
@Path("{alarmId}")
@Produces("application/json")
@RolesAllowed("read:alarms")
SentAlarm getAlarm(@BeanParam
 RequestParams requestParams,
 @PathParam("alarmId")
 Long alarmId)

updateAlarm

@PUT
@Path("{alarmId}")
@Consumes("application/json")
@RolesAllowed("write:alarms")
void updateAlarm(@BeanParam
 RequestParams requestParams,
 @PathParam("alarmId")
 Long alarmId,
 SentAlarm alarm)

removeAlarm

@DELETE
@Path("{alarmId}")
@RolesAllowed("write:alarms")
void removeAlarm(@BeanParam
 RequestParams requestParams,
 @PathParam("alarmId")
 Long alarmId)

getAssetLinks

@GET
@Path("{alarmId}/assets")
@Produces("application/json")
@RolesAllowed("read:alarms")
List<AlarmAssetLink> getAssetLinks(@BeanParam
 RequestParams requestParams,
 @PathParam("alarmId")
 Long alarmId,
 @QueryParam("realm")
 String realm)

setAssetLinks

@PUT
@Path("assets")
@Consumes("application/json")
@RolesAllowed("write:alarms")
void setAssetLinks(@BeanParam
 RequestParams requestParams,
 List<AlarmAssetLink> links)