Enum DashboardEntityType
- java.lang.Object
-
- java.lang.Enum<DashboardEntityType>
-
- com.redwood.scheduler.api.model.enumeration.DashboardEntityType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<DashboardEntityType,Integer>
,SchedulerIntegerEnumeration<DashboardEntityType>
,Serializable
,Comparable<DashboardEntityType>
public enum DashboardEntityType extends Enum<DashboardEntityType> implements SchedulerIntegerEnumeration<DashboardEntityType>
The type of the DashboardEntity, FOR INTERNAL USE ONLY (Integer Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ActionWork
The system health option Action workActiveJobGroups
The schedule health option Active job groupsAuditEntries
The housekeeping health option Audit entriesCustomHealth
Overview of all custom health optionsCustomQueryFilter
The custom health option for a Custom query filterDashboardOverview
Overview of all monitoring dashboard optionsHousekeepingDashboard
Housekeeping dashboardHousekeepingGlobalConfiguration
Global configuration for the Housekeeping dashboardHousekeepingHealth
Overview of all housekeeping health optionsHousekeepingJob
One of the housekeeping jobsHousekeepingJobs
The housekeeping health option Housekeeping jobsHousekeepingUserConfiguration
User configuration for the Housekeeping dashboardJobsActionRequired
The schedule health option Action requiredJobsDelayedInRemoteSystem
The schedule health option Delayed in remote systemJobsEventWait
The schedule health option Event waitJobsInIntermediateStates
The schedule health option In intermediate statesJobsLockWait
The schedule health option Lock waitJobsLongRunningAction
The schedule health option Long running actionJobsLongRuntime
The schedule health option Long runtimeJobsNotCurrentMaster
The schedule health option Not current masterJobsStartDelay
The schedule health option Start delayMissingSchedules
The schedule health option Missing schedulesMonitoringDashboard
Monitoring dashboardMonitoringGlobalConfiguration
Global configuration for the Monitoring dashboardMonitoringUserConfiguration
User configuration for the Monitoring dashboardPendingEvents
The housekeeping health option Pending eventsProcessServers
The system health option Process serversQueues
The system health option QueuesRetention
The housekeeping health option RetentionScheduleHealth
Overview of all schedule health optionsSecureGateway
The system health option Secure gatewaySystemHealth
Overview of all system health optionsUnrepliedOperatorMessages
The housekeeping health option Unreplied operator messagesUnrepliedUserMessages
The housekeeping health option Unreplied user messagesUnusedDefinitions
The housekeeping health option Unused definitions
-
Field Summary
Fields Modifier and Type Field Description static int
ActionWorkCode
The int returned from ActionWork.getCodeEx().static int
ActiveJobGroupsCode
The int returned from ActiveJobGroups.getCodeEx().static int
AuditEntriesCode
The int returned from AuditEntries.getCodeEx().static int
CustomHealthCode
The int returned from CustomHealth.getCodeEx().static int
CustomQueryFilterCode
The int returned from CustomQueryFilter.getCodeEx().static int
DashboardOverviewCode
The int returned from DashboardOverview.getCodeEx().static int
HousekeepingDashboardCode
The int returned from HousekeepingDashboard.getCodeEx().static int
HousekeepingGlobalConfigurationCode
The int returned from HousekeepingGlobalConfiguration.getCodeEx().static int
HousekeepingHealthCode
The int returned from HousekeepingHealth.getCodeEx().static int
HousekeepingJobCode
The int returned from HousekeepingJob.getCodeEx().static int
HousekeepingJobsCode
The int returned from HousekeepingJobs.getCodeEx().static int
HousekeepingUserConfigurationCode
The int returned from HousekeepingUserConfiguration.getCodeEx().static int
JobsActionRequiredCode
The int returned from JobsActionRequired.getCodeEx().static int
JobsDelayedInRemoteSystemCode
The int returned from JobsDelayedInRemoteSystem.getCodeEx().static int
JobsEventWaitCode
The int returned from JobsEventWait.getCodeEx().static int
JobsInIntermediateStatesCode
The int returned from JobsInIntermediateStates.getCodeEx().static int
JobsLockWaitCode
The int returned from JobsLockWait.getCodeEx().static int
JobsLongRunningActionCode
The int returned from JobsLongRunningAction.getCodeEx().static int
JobsLongRuntimeCode
The int returned from JobsLongRuntime.getCodeEx().static int
JobsNotCurrentMasterCode
The int returned from JobsNotCurrentMaster.getCodeEx().static int
JobsStartDelayCode
The int returned from JobsStartDelay.getCodeEx().static int
MissingSchedulesCode
The int returned from MissingSchedules.getCodeEx().static int
MonitoringDashboardCode
The int returned from MonitoringDashboard.getCodeEx().static int
MonitoringGlobalConfigurationCode
The int returned from MonitoringGlobalConfiguration.getCodeEx().static int
MonitoringUserConfigurationCode
The int returned from MonitoringUserConfiguration.getCodeEx().static int
PendingEventsCode
The int returned from PendingEvents.getCodeEx().static int
ProcessServersCode
The int returned from ProcessServers.getCodeEx().static int
QueuesCode
The int returned from Queues.getCodeEx().static int
RetentionCode
The int returned from Retention.getCodeEx().static int
ScheduleHealthCode
The int returned from ScheduleHealth.getCodeEx().static int
SecureGatewayCode
The int returned from SecureGateway.getCodeEx().static int
SystemHealthCode
The int returned from SystemHealth.getCodeEx().static int
UnrepliedOperatorMessagesCode
The int returned from UnrepliedOperatorMessages.getCodeEx().static int
UnrepliedUserMessagesCode
The int returned from UnrepliedUserMessages.getCodeEx().static int
UnusedDefinitionsCode
The int returned from UnusedDefinitions.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getCodeEx()
Get the code that is used to represent this enumeration in the database.Integer
getCodeExInteger()
Get the code that is used to represent this enumeration in the database.Integer
getCodeExValue()
Return the code for the enumeration item as the database type of this enumeration.String
getDescriptionKey()
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.String
getTranslationEN()
Get the English name of this enumeration.String
getTranslationKey()
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static DashboardEntityType
safeValueOf(String value)
Helper function to return the DashboardEntityType represented byvalue
.static DashboardEntityType
valueOf(int code)
Helper function to return the DashboardEntityType represented by code.static DashboardEntityType
valueOf(Integer code)
Helper function to return the DashboardEntityType represented by code.static DashboardEntityType
valueOf(String name)
Returns the enum constant of this type with the specified name.static DashboardEntityType
valueOfCode(String code)
Helper function to return the DashboardEntityType represented by code.static DashboardEntityType[]
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 interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
MonitoringDashboard
public static final DashboardEntityType MonitoringDashboard
Monitoring dashboard
-
DashboardOverview
public static final DashboardEntityType DashboardOverview
Overview of all monitoring dashboard options
-
SystemHealth
public static final DashboardEntityType SystemHealth
Overview of all system health options
-
ScheduleHealth
public static final DashboardEntityType ScheduleHealth
Overview of all schedule health options
-
CustomHealth
public static final DashboardEntityType CustomHealth
Overview of all custom health options
-
MonitoringGlobalConfiguration
public static final DashboardEntityType MonitoringGlobalConfiguration
Global configuration for the Monitoring dashboard
-
MonitoringUserConfiguration
public static final DashboardEntityType MonitoringUserConfiguration
User configuration for the Monitoring dashboard
-
ProcessServers
public static final DashboardEntityType ProcessServers
The system health option Process servers
-
Queues
public static final DashboardEntityType Queues
The system health option Queues
-
SecureGateway
public static final DashboardEntityType SecureGateway
The system health option Secure gateway
-
ActionWork
public static final DashboardEntityType ActionWork
The system health option Action work
-
ActiveJobGroups
public static final DashboardEntityType ActiveJobGroups
The schedule health option Active job groups
-
MissingSchedules
public static final DashboardEntityType MissingSchedules
The schedule health option Missing schedules
-
JobsLongRuntime
public static final DashboardEntityType JobsLongRuntime
The schedule health option Long runtime
-
JobsLongRunningAction
public static final DashboardEntityType JobsLongRunningAction
The schedule health option Long running action
-
JobsActionRequired
public static final DashboardEntityType JobsActionRequired
The schedule health option Action required
-
JobsStartDelay
public static final DashboardEntityType JobsStartDelay
The schedule health option Start delay
-
JobsLockWait
public static final DashboardEntityType JobsLockWait
The schedule health option Lock wait
-
JobsEventWait
public static final DashboardEntityType JobsEventWait
The schedule health option Event wait
-
JobsInIntermediateStates
public static final DashboardEntityType JobsInIntermediateStates
The schedule health option In intermediate states
-
JobsDelayedInRemoteSystem
public static final DashboardEntityType JobsDelayedInRemoteSystem
The schedule health option Delayed in remote system
-
JobsNotCurrentMaster
public static final DashboardEntityType JobsNotCurrentMaster
The schedule health option Not current master
-
CustomQueryFilter
public static final DashboardEntityType CustomQueryFilter
The custom health option for a Custom query filter
-
HousekeepingDashboard
public static final DashboardEntityType HousekeepingDashboard
Housekeeping dashboard
-
HousekeepingHealth
public static final DashboardEntityType HousekeepingHealth
Overview of all housekeeping health options
-
HousekeepingGlobalConfiguration
public static final DashboardEntityType HousekeepingGlobalConfiguration
Global configuration for the Housekeeping dashboard
-
HousekeepingUserConfiguration
public static final DashboardEntityType HousekeepingUserConfiguration
User configuration for the Housekeeping dashboard
-
UnrepliedOperatorMessages
public static final DashboardEntityType UnrepliedOperatorMessages
The housekeeping health option Unreplied operator messages
-
UnrepliedUserMessages
public static final DashboardEntityType UnrepliedUserMessages
The housekeeping health option Unreplied user messages
-
PendingEvents
public static final DashboardEntityType PendingEvents
The housekeeping health option Pending events
-
AuditEntries
public static final DashboardEntityType AuditEntries
The housekeeping health option Audit entries
-
UnusedDefinitions
public static final DashboardEntityType UnusedDefinitions
The housekeeping health option Unused definitions
-
Retention
public static final DashboardEntityType Retention
The housekeeping health option Retention
-
HousekeepingJobs
public static final DashboardEntityType HousekeepingJobs
The housekeeping health option Housekeeping jobs
-
HousekeepingJob
public static final DashboardEntityType HousekeepingJob
One of the housekeeping jobs
-
-
Field Detail
-
MonitoringDashboardCode
public static final int MonitoringDashboardCode
The int returned from MonitoringDashboard.getCodeEx().- See Also:
MonitoringDashboard
, Constant Field Values
-
DashboardOverviewCode
public static final int DashboardOverviewCode
The int returned from DashboardOverview.getCodeEx().- See Also:
DashboardOverview
, Constant Field Values
-
SystemHealthCode
public static final int SystemHealthCode
The int returned from SystemHealth.getCodeEx().- See Also:
SystemHealth
, Constant Field Values
-
ScheduleHealthCode
public static final int ScheduleHealthCode
The int returned from ScheduleHealth.getCodeEx().- See Also:
ScheduleHealth
, Constant Field Values
-
CustomHealthCode
public static final int CustomHealthCode
The int returned from CustomHealth.getCodeEx().- See Also:
CustomHealth
, Constant Field Values
-
MonitoringGlobalConfigurationCode
public static final int MonitoringGlobalConfigurationCode
The int returned from MonitoringGlobalConfiguration.getCodeEx().
-
MonitoringUserConfigurationCode
public static final int MonitoringUserConfigurationCode
The int returned from MonitoringUserConfiguration.getCodeEx().- See Also:
MonitoringUserConfiguration
, Constant Field Values
-
ProcessServersCode
public static final int ProcessServersCode
The int returned from ProcessServers.getCodeEx().- See Also:
ProcessServers
, Constant Field Values
-
QueuesCode
public static final int QueuesCode
The int returned from Queues.getCodeEx().- See Also:
Queues
, Constant Field Values
-
SecureGatewayCode
public static final int SecureGatewayCode
The int returned from SecureGateway.getCodeEx().- See Also:
SecureGateway
, Constant Field Values
-
ActionWorkCode
public static final int ActionWorkCode
The int returned from ActionWork.getCodeEx().- See Also:
ActionWork
, Constant Field Values
-
ActiveJobGroupsCode
public static final int ActiveJobGroupsCode
The int returned from ActiveJobGroups.getCodeEx().- See Also:
ActiveJobGroups
, Constant Field Values
-
MissingSchedulesCode
public static final int MissingSchedulesCode
The int returned from MissingSchedules.getCodeEx().- See Also:
MissingSchedules
, Constant Field Values
-
JobsLongRuntimeCode
public static final int JobsLongRuntimeCode
The int returned from JobsLongRuntime.getCodeEx().- See Also:
JobsLongRuntime
, Constant Field Values
-
JobsLongRunningActionCode
public static final int JobsLongRunningActionCode
The int returned from JobsLongRunningAction.getCodeEx().- See Also:
JobsLongRunningAction
, Constant Field Values
-
JobsActionRequiredCode
public static final int JobsActionRequiredCode
The int returned from JobsActionRequired.getCodeEx().- See Also:
JobsActionRequired
, Constant Field Values
-
JobsStartDelayCode
public static final int JobsStartDelayCode
The int returned from JobsStartDelay.getCodeEx().- See Also:
JobsStartDelay
, Constant Field Values
-
JobsLockWaitCode
public static final int JobsLockWaitCode
The int returned from JobsLockWait.getCodeEx().- See Also:
JobsLockWait
, Constant Field Values
-
JobsEventWaitCode
public static final int JobsEventWaitCode
The int returned from JobsEventWait.getCodeEx().- See Also:
JobsEventWait
, Constant Field Values
-
JobsInIntermediateStatesCode
public static final int JobsInIntermediateStatesCode
The int returned from JobsInIntermediateStates.getCodeEx().- See Also:
JobsInIntermediateStates
, Constant Field Values
-
JobsDelayedInRemoteSystemCode
public static final int JobsDelayedInRemoteSystemCode
The int returned from JobsDelayedInRemoteSystem.getCodeEx().- See Also:
JobsDelayedInRemoteSystem
, Constant Field Values
-
JobsNotCurrentMasterCode
public static final int JobsNotCurrentMasterCode
The int returned from JobsNotCurrentMaster.getCodeEx().- See Also:
JobsNotCurrentMaster
, Constant Field Values
-
CustomQueryFilterCode
public static final int CustomQueryFilterCode
The int returned from CustomQueryFilter.getCodeEx().- See Also:
CustomQueryFilter
, Constant Field Values
-
HousekeepingDashboardCode
public static final int HousekeepingDashboardCode
The int returned from HousekeepingDashboard.getCodeEx().- See Also:
HousekeepingDashboard
, Constant Field Values
-
HousekeepingHealthCode
public static final int HousekeepingHealthCode
The int returned from HousekeepingHealth.getCodeEx().- See Also:
HousekeepingHealth
, Constant Field Values
-
HousekeepingGlobalConfigurationCode
public static final int HousekeepingGlobalConfigurationCode
The int returned from HousekeepingGlobalConfiguration.getCodeEx().
-
HousekeepingUserConfigurationCode
public static final int HousekeepingUserConfigurationCode
The int returned from HousekeepingUserConfiguration.getCodeEx().
-
UnrepliedOperatorMessagesCode
public static final int UnrepliedOperatorMessagesCode
The int returned from UnrepliedOperatorMessages.getCodeEx().- See Also:
UnrepliedOperatorMessages
, Constant Field Values
-
UnrepliedUserMessagesCode
public static final int UnrepliedUserMessagesCode
The int returned from UnrepliedUserMessages.getCodeEx().- See Also:
UnrepliedUserMessages
, Constant Field Values
-
PendingEventsCode
public static final int PendingEventsCode
The int returned from PendingEvents.getCodeEx().- See Also:
PendingEvents
, Constant Field Values
-
AuditEntriesCode
public static final int AuditEntriesCode
The int returned from AuditEntries.getCodeEx().- See Also:
AuditEntries
, Constant Field Values
-
UnusedDefinitionsCode
public static final int UnusedDefinitionsCode
The int returned from UnusedDefinitions.getCodeEx().- See Also:
UnusedDefinitions
, Constant Field Values
-
RetentionCode
public static final int RetentionCode
The int returned from Retention.getCodeEx().- See Also:
Retention
, Constant Field Values
-
HousekeepingJobsCode
public static final int HousekeepingJobsCode
The int returned from HousekeepingJobs.getCodeEx().- See Also:
HousekeepingJobs
, Constant Field Values
-
HousekeepingJobCode
public static final int HousekeepingJobCode
The int returned from HousekeepingJob.getCodeEx().- See Also:
HousekeepingJob
, Constant Field Values
-
-
Method Detail
-
values
public static DashboardEntityType[] 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 (DashboardEntityType c : DashboardEntityType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static DashboardEntityType 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 nameNullPointerException
- if the argument is null
-
valueOfCode
public static DashboardEntityType valueOfCode(String code)
Helper function to return the DashboardEntityType represented by code. If code is null, empty, or not a valid code then this method will return null.- Parameters:
code
- A string that is one of the codes for DashboardEntityType- Returns:
- The DashboardEntityType corresponding to code, or null.
-
safeValueOf
public static DashboardEntityType safeValueOf(String value)
Helper function to return the DashboardEntityType represented byvalue
. Ifvalue
is null, or not a valid DashboardEntityType enumeration then this method will return null.The main difference between this method and
valueOf(String)
, is that this method will return null when passed an invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The DashboardEntityType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static DashboardEntityType valueOf(Integer code)
Helper function to return the DashboardEntityType represented by code. If code is null, or not a valid DashboardEntityType code then this method will return null.- Parameters:
code
- Integer that is one of the codes for HandlerAction- Returns:
- The DashboardEntityType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static DashboardEntityType valueOf(int code)
Helper function to return the DashboardEntityType represented by code. If code is not a valid DashboardEntityType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The DashboardEntityType corresponding to code, or null, if code is not a valid code
-
getCodeEx
public int getCodeEx()
Description copied from interface:SchedulerIntegerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeEx
in interfaceSchedulerIntegerEnumeration<DashboardEntityType>
- Returns:
- the database code for the enumeration
-
getCodeExValue
public Integer getCodeExValue()
Description copied from interface:BaseSchedulerEnumeration
Return the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValue
in interfaceBaseSchedulerEnumeration<DashboardEntityType,Integer>
- Returns:
- the enumeration code
-
getCodeExInteger
public Integer getCodeExInteger()
Description copied from interface:SchedulerIntegerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExInteger
in interfaceSchedulerIntegerEnumeration<DashboardEntityType>
- Returns:
- the database code for the enumeration
-
getTranslationKey
public String getTranslationKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
getTranslationKey
in interfaceBaseSchedulerEnumeration<DashboardEntityType,Integer>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<DashboardEntityType,Integer>
- Returns:
- the English name of this enumeration.
-
getDescriptionKey
public String getDescriptionKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
getDescriptionKey
in interfaceBaseSchedulerEnumeration<DashboardEntityType,Integer>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
-