Package com.thingworx.system.subsystems.alerts.data

Class Alert

java.lang.Object

com.thingworx.system.subsystems.alerts.data.Alert

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class Alert
extends Object

Represents an alert that can be raised.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	_logger	the logger

Constructor Summary

Constructors

Constructor	Description
Alert()	Initializes this instace with default values.

Method Summary

Modifier and Type	Method	Description
AlertDefinition	getAlertDefinition()	Gets the definition currently describing this alert.
IPrimitiveType	getAttribute(String parameterName)	Gets the value of the specified attribute
Integer	getPriority()	Gets this alert's priority.
Boolean	hasAttribute(String parameterName)	Determines whether or not this alert has the specified attribute.
Boolean	isEnabled()	Gets whether or not this alert is enabled.

Methods inherited from class java.lang.Object

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

Field Details

_logger

public static final org.slf4j.Logger _logger

the logger

Constructor Details

Alert

public Alert()

Initializes this instace with default values.

Method Details

getPriority

@ThingworxExtensionApiMethod(since={6,6})
public Integer getPriority()

Gets this alert's priority.

Returns:

this alert's priority

See Also:

• AlertDefinition.getPriority()

isEnabled

@ThingworxExtensionApiMethod(since={6,6})
public Boolean isEnabled()

Gets whether or not this alert is enabled.

Returns:

a non-null Boolean object that is true if this is alert is enabled, otherwise false

getAlertDefinition

@ThingworxExtensionApiMethod(since={6,6})
public AlertDefinition getAlertDefinition()

Gets the definition currently describing this alert.

Returns:

this alert's definition

hasAttribute

@ThingworxExtensionApiMethod(since={6,6})
public Boolean hasAttribute(String parameterName)

Determines whether or not this alert has the specified attribute.

Parameters:

parameterName - the attribute name

Returns:

a non-null Boolean object that is true if this alert has the specified attribute, otherwise false

getAttribute

@ThingworxExtensionApiMethod(since={6,6})
public IPrimitiveType getAttribute(String parameterName)

Gets the value of the specified attribute

Parameters:

parameterName - the name of the attribute

Returns:

the value of the attribute, or null if parameterName does not identify an attribute on this alert