Package com.inductiveautomation.ignition.gateway.model

Class ProfileStatus

java.lang.Object

com.inductiveautomation.ignition.gateway.model.ProfileStatus

All Implemented Interfaces:

Serializable

public class ProfileStatus
extends Object
implements Serializable

This class lets various "profile" items (notification profile, tag history profiles, etc) communicate basic running state information. It consists of a general State, such as "Good" or "Errored", and then a localized message, which should be a very short clarification of the state.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProfileStatus.State	This enum defines the general state in coarse terms.

Field Summary

Fields

Modifier and Type	Field	Description
static final ProfileStatus	DEMO_EXPIRED
static final ProfileStatus	DISABLED
static final ProfileStatus	ERRORED
static final ProfileStatus	RUNNING
static final ProfileStatus	STARTING
static final ProfileStatus	STOPPING
static final ProfileStatus	UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ProfileStatus(ProfileStatus.State state, LocalizedString message)
ProfileStatus(ProfileStatus.State state, LocalizedString message, String errorDetails)

Method Summary

Modifier and Type	Method	Description
String	getErrorDetails()
LocalizedString	getMessage()
ProfileStatus.State	getState()

Methods inherited from class java.lang.Object

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

Field Details

RUNNING

public static final ProfileStatus RUNNING

ERRORED

public static final ProfileStatus ERRORED

UNKNOWN

public static final ProfileStatus UNKNOWN

DISABLED

public static final ProfileStatus DISABLED

DEMO_EXPIRED

public static final ProfileStatus DEMO_EXPIRED

STARTING

public static final ProfileStatus STARTING

STOPPING

public static final ProfileStatus STOPPING

Constructor Details

ProfileStatus

public ProfileStatus(ProfileStatus.State state,
 LocalizedString message)

ProfileStatus

public ProfileStatus(ProfileStatus.State state,
 LocalizedString message,
 String errorDetails)

Method Details

getState

public ProfileStatus.State getState()

getMessage

public LocalizedString getMessage()

getErrorDetails

public String getErrorDetails()