ConfigCategory

java.lang.Object
- com.inductiveautomation.ignition.gateway.web.models.ConfigCategory

All Implemented Interfaces:

java.lang.Comparable<ConfigCategory>
```
public final class ConfigCategory
extends java.lang.Object
implements java.lang.Comparable<ConfigCategory>
```
A config category represents the 1st tier of the config menu. Platform provided categories are defined as static instances on this class.

Field Summary

Fields
Modifier and Type	Field	Description
`static ConfigCategory`	`ALARMING`
`static ConfigCategory`	`DATABASES`
`static java.util.List<ConfigCategory>`	`EDGE_CATEGORIES`
`static ConfigCategory`	`EDGE_SYNC_SVC`
`static ConfigCategory`	`NETWORK`
`static ConfigCategory`	`OPC`
`static ConfigCategory`	`SECURITY`
`static java.util.List<ConfigCategory>`	`STANDARD_CATEGORIES`
`static ConfigCategory`	`SYSTEM`
`static ConfigCategory`	`TAGS`

Constructor Summary

Constructors
Constructor	Description
`ConfigCategory(java.lang.String name, java.lang.String displayKey)`	Create a new config category.
`ConfigCategory(java.lang.String name, java.lang.String displayKey, int order)`	Creates a category with an explicit order.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(ConfigCategory o)`
`java.lang.String`	`getDisplayKey()`
`java.lang.String`	`getName()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYSTEM

public static final ConfigCategory SYSTEM

NETWORK

public static final ConfigCategory NETWORK

SECURITY

public static final ConfigCategory SECURITY

DATABASES

public static final ConfigCategory DATABASES

ALARMING

public static final ConfigCategory ALARMING

TAGS

public static final ConfigCategory TAGS

OPC
```
public static final ConfigCategory OPC
```

EDGE_SYNC_SVC

public static final ConfigCategory EDGE_SYNC_SVC

STANDARD_CATEGORIES

public static final java.util.List<ConfigCategory> STANDARD_CATEGORIES

EDGE_CATEGORIES

public static final java.util.List<ConfigCategory> EDGE_CATEGORIES

Constructor Detail
- ConfigCategory
```
public ConfigCategory(java.lang.String name,
                      java.lang.String displayKey)
```
  Create a new config category. Order will be set to 10,000, the default order number where categories are then sorted alphabetically by keyname.
  
  Parameters:
  
  name - The id/name of the category. Should be short, lower-case, no spaces or punctuation.
  
  displayKey - The resource key of the display string for this category.
- ConfigCategory
```
public ConfigCategory(java.lang.String name,
                      java.lang.String displayKey,
                      int order)
```
  Creates a category with an explicit order.

Method Detail

getName
```
public java.lang.String getName()
```

getDisplayKey

public java.lang.String getDisplayKey()

compareTo
```
public int compareTo(ConfigCategory o)
```
Specified by:

compareTo in interface java.lang.Comparable<ConfigCategory>