ElementRole (SiteWhere Web Components 1.5.0 API)

java.lang.Object
- java.lang.Enum<ElementRole>
- - com.sitewhere.web.configuration.model.ElementRole

All Implemented Interfaces:

Serializable, Comparable<ElementRole>
```
public enum ElementRole
extends Enum<ElementRole>
```
Used to indicate role of an element.

Author:

Derek

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ElementRole.Serializer

Nested Classes
Modifier and Type	Class and Description
`static class`	`ElementRole.Serializer`

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AssetManagment` Asset Management element.
`AssetManagment_AssetModule` Asset Management.
`BatchOperations_BatchOperationManager` Batch operations container.
`CommandDestinations_BinaryCommandEncoder` Command destination.
`CommandDestinations_CommandDestination` Command destinations.
`CommandDestinations_CommandEncoder` Command destination.
`CommandDestinations_MqttParameterExtractor` Command destination.
`CommandDestinations_ParameterExtractor` Command destination.
`CommandDestinations_SmsParameterExtractor` Command destination.
`CommandDestinations_StringCommandEncoder` Command destination.
`CommandRouting_CommandRouter` Command routing container.
`CommandRouting_SpecificationMappingRouter` Specification mapping router.
`CommandRouting_SpecificationMappingRouter_Mapping` Specification mapping router.
`DataManagement` Data management.
`DataManagement_AssetModelInitializer` Data management container.
`DataManagement_CacheProvider` Data management container.
`DataManagement_Datastore` Data management container.
`DataManagement_DeviceModelInitializer` Data management container.
`DataManagement_ScheduleModelInitializer` Data management container.
`DeviceCommunication` Device communication element.
`DeviceCommunication_BatchOperations` Device communication container.
`DeviceCommunication_CommandDestinations` Device communication container.
`DeviceCommunication_CommandRouting` Device communication container.
`DeviceCommunication_DeviceServices` Device communication container.
`DeviceCommunication_EventSources` Device communication container.
`DeviceServices_RegistrationManager` Device services container.
`DeviceServices_SymbolGeneratorManager` Device services container.
`EventProcessing` Event processing.
`EventProcessing_InboundProcessingStrategy` Device communication container.
`EventProcessing_OutboundProcessingStrategy` Device communication container.
`EventSource_BinaryEventDecoder` Event source.
`EventSource_EventDecoder` Event source.
`EventSource_StringEventDecoder` Event source.
`EventSources_EventSource` Event sources container.
`EventSources_SocketEventSource` Event sources container.
`EventSources_SocketInteractionHandlerFactory` Socket event source.
`EventSources_WebSocketEventSource` Event sources container.
`EventSources_WebSocketHeader` WebSocket event source.
`Globals` Globals element.
`Globals_Global` Top level element.
`InboundProcessingChain` Inbound processing chain element.
`InboundProcessingChain_EventProcessor` Inbound processing chain.
`InboundProcessingStrategy_Strategy` Inbound processing strategy container.
`OutboundProcessingChain` Outbound processing chain element.
`OutboundProcessingChain_EventProcessor` Outbound processing chain.
`OutboundProcessingChain_FilteredEventProcessor` Outbound processing chain.
`OutboundProcessingChain_Filters` Outbound processing chain.
`OutboundProcessingChain_MqttEventProcessor` Outbound processing chain.
`OutboundProcessingChain_OutboundFilters` Outbound processing chain.
`OutboundProcessingChain_RouteBuilder` MQTT event processsor.
`OutboundProcessingChain_SiddhiCallback` Siddhi query.
`OutboundProcessingChain_SiddhiEventProcessor` Outbound processing chain.
`OutboundProcessingChain_SiddhiQuery` Siddhi event processsor.
`OutboundProcessingChain_ZoneTest` Zone test event processsor.
`OutboundProcessingChain_ZoneTestEventProcessor` Outbound processing chain.
`OutboundProcessingStrategy_Strategy` Outbound processing strategy container.
`Root` Top level element.
`SymbolGeneratorManager_SymbolGenerator` Symbol generator manager.

Method Summary

Methods
Modifier and Type	Method and Description
`ElementRole[]`	`getChildren()`
`String`	`getName()`
`ElementRole[]`	`getSubtypes()`
`boolean`	`isMultiple()`
`boolean`	`isOptional()`
`boolean`	`isPermanent()`
`boolean`	`isReorderable()`
`void`	`setChildren(ElementRole[] children)`
`void`	`setMultiple(boolean multiple)`
`void`	`setName(String name)`
`void`	`setOptional(boolean optional)`
`void`	`setPermanent(boolean permanent)`
`void`	`setReorderable(boolean reorderable)`
`void`	`setSubtypes(ElementRole[] subtypes)`
`static ElementRole`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ElementRole[]`	`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
  - Globals_Global
```
public static final ElementRole Globals_Global
```
    Top level element.
  - Globals
```
public static final ElementRole Globals
```
    Globals element.
  - DataManagement_Datastore
```
public static final ElementRole DataManagement_Datastore
```
    Data management container. Datastore configuration.
  - DataManagement_CacheProvider
```
public static final ElementRole DataManagement_CacheProvider
```
    Data management container. Cache provider configuration.
  - DataManagement_DeviceModelInitializer
```
public static final ElementRole DataManagement_DeviceModelInitializer
```
    Data management container. Device model initializer configuration.
  - DataManagement_AssetModelInitializer
```
public static final ElementRole DataManagement_AssetModelInitializer
```
    Data management container. Asset model initializer configuration.
  - DataManagement_ScheduleModelInitializer
```
public static final ElementRole DataManagement_ScheduleModelInitializer
```
    Data management container. Schedule model initializer configuration.
  - DataManagement
```
public static final ElementRole DataManagement
```
    Data management.
  - InboundProcessingStrategy_Strategy
```
public static final ElementRole InboundProcessingStrategy_Strategy
```
    Inbound processing strategy container. Strategy.
  - EventProcessing_InboundProcessingStrategy
```
public static final ElementRole EventProcessing_InboundProcessingStrategy
```
    Device communication container. Inbound processing strategy.
  - OutboundProcessingStrategy_Strategy
```
public static final ElementRole OutboundProcessingStrategy_Strategy
```
    Outbound processing strategy container. Strategy.
  - EventProcessing_OutboundProcessingStrategy
```
public static final ElementRole EventProcessing_OutboundProcessingStrategy
```
    Device communication container. Outbound processing strategy.
  - InboundProcessingChain_EventProcessor
```
public static final ElementRole InboundProcessingChain_EventProcessor
```
    Inbound processing chain. Event processor.
  - InboundProcessingChain
```
public static final ElementRole InboundProcessingChain
```
    Inbound processing chain element.
  - OutboundProcessingChain_OutboundFilters
```
public static final ElementRole OutboundProcessingChain_OutboundFilters
```
    Outbound processing chain. Processsor filters.
  - OutboundProcessingChain_Filters
```
public static final ElementRole OutboundProcessingChain_Filters
```
    Outbound processing chain. Processsor filter criteria.
  - OutboundProcessingChain_FilteredEventProcessor
```
public static final ElementRole OutboundProcessingChain_FilteredEventProcessor
```
    Outbound processing chain. Filtered event processor.
  - OutboundProcessingChain_ZoneTest
```
public static final ElementRole OutboundProcessingChain_ZoneTest
```
    Zone test event processsor. Zone test.
  - OutboundProcessingChain_ZoneTestEventProcessor
```
public static final ElementRole OutboundProcessingChain_ZoneTestEventProcessor
```
    Outbound processing chain. Zone test event processor.
  - OutboundProcessingChain_RouteBuilder
```
public static final ElementRole OutboundProcessingChain_RouteBuilder
```
    MQTT event processsor. Route builder.
  - OutboundProcessingChain_MqttEventProcessor
```
public static final ElementRole OutboundProcessingChain_MqttEventProcessor
```
    Outbound processing chain. MQTT event processor.
  - OutboundProcessingChain_SiddhiCallback
```
public static final ElementRole OutboundProcessingChain_SiddhiCallback
```
    Siddhi query. Callback.
  - OutboundProcessingChain_SiddhiQuery
```
public static final ElementRole OutboundProcessingChain_SiddhiQuery
```
    Siddhi event processsor. Siddhi query.
  - OutboundProcessingChain_SiddhiEventProcessor
```
public static final ElementRole OutboundProcessingChain_SiddhiEventProcessor
```
    Outbound processing chain. Siddhi event processor.
  - OutboundProcessingChain_EventProcessor
```
public static final ElementRole OutboundProcessingChain_EventProcessor
```
    Outbound processing chain. Event processor.
  - OutboundProcessingChain
```
public static final ElementRole OutboundProcessingChain
```
    Outbound processing chain element.
  - EventProcessing
```
public static final ElementRole EventProcessing
```
    Event processing.
  - EventSource_BinaryEventDecoder
```
public static final ElementRole EventSource_BinaryEventDecoder
```
    Event source. Binary event decoder.
  - EventSource_StringEventDecoder
```
public static final ElementRole EventSource_StringEventDecoder
```
    Event source. String event decoder.
  - EventSource_EventDecoder
```
public static final ElementRole EventSource_EventDecoder
```
    Event source. Event decoder.
  - EventSources_SocketInteractionHandlerFactory
```
public static final ElementRole EventSources_SocketInteractionHandlerFactory
```
    Socket event source. Socket interaction handler factory.
  - EventSources_SocketEventSource
```
public static final ElementRole EventSources_SocketEventSource
```
    Event sources container. Event source.
  - EventSources_WebSocketHeader
```
public static final ElementRole EventSources_WebSocketHeader
```
    WebSocket event source. Header.
  - EventSources_WebSocketEventSource
```
public static final ElementRole EventSources_WebSocketEventSource
```
    Event sources container. Event source.
  - EventSources_EventSource
```
public static final ElementRole EventSources_EventSource
```
    Event sources container. Event source.
  - DeviceCommunication_EventSources
```
public static final ElementRole DeviceCommunication_EventSources
```
    Device communication container. Event sources configuration.
  - SymbolGeneratorManager_SymbolGenerator
```
public static final ElementRole SymbolGeneratorManager_SymbolGenerator
```
    Symbol generator manager. Symbol generator.
  - DeviceServices_SymbolGeneratorManager
```
public static final ElementRole DeviceServices_SymbolGeneratorManager
```
    Device services container. Symbol generator manager.
  - DeviceServices_RegistrationManager
```
public static final ElementRole DeviceServices_RegistrationManager
```
    Device services container. Registration manager.
  - DeviceCommunication_DeviceServices
```
public static final ElementRole DeviceCommunication_DeviceServices
```
    Device communication container. Device Services.
  - BatchOperations_BatchOperationManager
```
public static final ElementRole BatchOperations_BatchOperationManager
```
    Batch operations container. Batch operation manager.
  - DeviceCommunication_BatchOperations
```
public static final ElementRole DeviceCommunication_BatchOperations
```
    Device communication container. Batch operations.
  - CommandRouting_SpecificationMappingRouter_Mapping
```
public static final ElementRole CommandRouting_SpecificationMappingRouter_Mapping
```
    Specification mapping router. Mapping.
  - CommandRouting_SpecificationMappingRouter
```
public static final ElementRole CommandRouting_SpecificationMappingRouter
```
    Specification mapping router. Mapping.
  - CommandRouting_CommandRouter
```
public static final ElementRole CommandRouting_CommandRouter
```
    Command routing container. Command router implementation.
  - DeviceCommunication_CommandRouting
```
public static final ElementRole DeviceCommunication_CommandRouting
```
    Device communication container. Command routing configuration.
  - CommandDestinations_StringCommandEncoder
```
public static final ElementRole CommandDestinations_StringCommandEncoder
```
    Command destination. String command encoder.
  - CommandDestinations_BinaryCommandEncoder
```
public static final ElementRole CommandDestinations_BinaryCommandEncoder
```
    Command destination. Binary command encoder.
  - CommandDestinations_CommandEncoder
```
public static final ElementRole CommandDestinations_CommandEncoder
```
    Command destination. Command encoder.
  - CommandDestinations_MqttParameterExtractor
```
public static final ElementRole CommandDestinations_MqttParameterExtractor
```
    Command destination. MQTT parameter extractor.
  - CommandDestinations_SmsParameterExtractor
```
public static final ElementRole CommandDestinations_SmsParameterExtractor
```
    Command destination. MQTT parameter extractor.
  - CommandDestinations_ParameterExtractor
```
public static final ElementRole CommandDestinations_ParameterExtractor
```
    Command destination. Parameter extractor.
  - CommandDestinations_CommandDestination
```
public static final ElementRole CommandDestinations_CommandDestination
```
    Command destinations. Command destination.
  - DeviceCommunication_CommandDestinations
```
public static final ElementRole DeviceCommunication_CommandDestinations
```
    Device communication container. Command destinations configuration.
  - DeviceCommunication
```
public static final ElementRole DeviceCommunication
```
    Device communication element.
  - AssetManagment_AssetModule
```
public static final ElementRole AssetManagment_AssetModule
```
    Asset Management. Asset module
  - AssetManagment
```
public static final ElementRole AssetManagment
```
    Asset Management element.
  - Root
```
public static final ElementRole Root
```
    Top level element.
- Method Detail
  - values
```
public static ElementRole[] 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 (ElementRole c : ElementRole.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ElementRole valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - isOptional
```
public boolean isOptional()
```
  - setOptional
```
public void setOptional(boolean optional)
```
  - isMultiple
```
public boolean isMultiple()
```
  - setMultiple
```
public void setMultiple(boolean multiple)
```
  - isReorderable
```
public boolean isReorderable()
```
  - setReorderable
```
public void setReorderable(boolean reorderable)
```
  - isPermanent
```
public boolean isPermanent()
```
  - setPermanent
```
public void setPermanent(boolean permanent)
```
  - getChildren
```
public ElementRole[] getChildren()
```
  - setChildren
```
public void setChildren(ElementRole[] children)
```
  - getSubtypes
```
public ElementRole[] getSubtypes()
```
  - setSubtypes
```
public void setSubtypes(ElementRole[] subtypes)
```

Enum ElementRole

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Globals_Global

Globals

DataManagement_Datastore

DataManagement_CacheProvider

DataManagement_DeviceModelInitializer

DataManagement_AssetModelInitializer

DataManagement_ScheduleModelInitializer

DataManagement

InboundProcessingStrategy_Strategy

EventProcessing_InboundProcessingStrategy

OutboundProcessingStrategy_Strategy

EventProcessing_OutboundProcessingStrategy

InboundProcessingChain_EventProcessor

InboundProcessingChain

OutboundProcessingChain_OutboundFilters

OutboundProcessingChain_Filters

OutboundProcessingChain_FilteredEventProcessor

OutboundProcessingChain_ZoneTest

OutboundProcessingChain_ZoneTestEventProcessor

OutboundProcessingChain_RouteBuilder

OutboundProcessingChain_MqttEventProcessor

OutboundProcessingChain_SiddhiCallback

OutboundProcessingChain_SiddhiQuery

OutboundProcessingChain_SiddhiEventProcessor

OutboundProcessingChain_EventProcessor

OutboundProcessingChain

EventProcessing

EventSource_BinaryEventDecoder

EventSource_StringEventDecoder

EventSource_EventDecoder

EventSources_SocketInteractionHandlerFactory

EventSources_SocketEventSource

EventSources_WebSocketHeader

EventSources_WebSocketEventSource

EventSources_EventSource

DeviceCommunication_EventSources

SymbolGeneratorManager_SymbolGenerator

DeviceServices_SymbolGeneratorManager

DeviceServices_RegistrationManager

DeviceCommunication_DeviceServices

BatchOperations_BatchOperationManager

DeviceCommunication_BatchOperations

CommandRouting_SpecificationMappingRouter_Mapping

CommandRouting_SpecificationMappingRouter

CommandRouting_CommandRouter

DeviceCommunication_CommandRouting

CommandDestinations_StringCommandEncoder

CommandDestinations_BinaryCommandEncoder

CommandDestinations_CommandEncoder

CommandDestinations_MqttParameterExtractor

CommandDestinations_SmsParameterExtractor

CommandDestinations_ParameterExtractor

CommandDestinations_CommandDestination

DeviceCommunication_CommandDestinations

DeviceCommunication

AssetManagment_AssetModule

AssetManagment

Root

Method Detail

values

valueOf

getName

setName

isOptional

setOptional

isMultiple

setMultiple

isReorderable

setReorderable

isPermanent

setPermanent

getChildren

setChildren