Package com.thingworx.types.constants

Enum QualityStatus

java.lang.Object

java.lang.Enum<QualityStatus>

com.thingworx.types.constants.QualityStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<QualityStatus>

@ThingworxExtensionApiClass(since={6,6})
public enum QualityStatus
extends java.lang.Enum<QualityStatus>

The quality status in comparison to other statuses.

Possible values include:

• UNKNOWN
• GOOD
• BAD
• OUT_OF_RANGE
• UNVERIFIED_SOURCE

Commonly used in property writes/reads and connections.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BAD	The status is bad.
GOOD	The status is good.
OUT_OF_RANGE	The status is out of range.
UNKNOWN	The status is unknown.
UNVERIFIED_SOURCE	The status is unverified source.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	QUALITY_OPTION

Method Summary

Modifier and Type	Method	Description
byte	code()
static QualityStatus	fromCode(byte code)	Constructs a QualityStatus from its code equivalent.
static QualityStatus	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static QualityStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BAD

public static final QualityStatus BAD

The status is bad.

OUT_OF_RANGE

public static final QualityStatus OUT_OF_RANGE

The status is out of range.

UNKNOWN

public static final QualityStatus UNKNOWN

The status is unknown.

GOOD

public static final QualityStatus GOOD

The status is good.

UNVERIFIED_SOURCE

public static final QualityStatus UNVERIFIED_SOURCE

The status is unverified source.

Field Detail

QUALITY_OPTION

public static final java.lang.String QUALITY_OPTION

See Also:

Constant Field Values

Method Detail

values

public static QualityStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QualityStatus c : QualityStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QualityStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

code

@ThingworxExtensionApiMethod(since={6,6})
public byte code()

Returns:

The status as its code equivalent.

fromCode

@ThingworxExtensionApiMethod(since={6,6})
public static QualityStatus fromCode(byte code)

Constructs a QualityStatus from its code equivalent.

Parameters:

code - The code equivalent of the QualityStatus enumeration.

Returns:

The enumeration QualityStatus of the code provided, or null if the code is not recognized.