Enum JobGroupCalculationStatus
- java.lang.Object
-
- java.lang.Enum<JobGroupCalculationStatus>
-
- com.redwood.scheduler.api.model.enumeration.JobGroupCalculationStatus
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<JobGroupCalculationStatus,Character>,SchedulerEnumeration<JobGroupCalculationStatus>,Serializable,Comparable<JobGroupCalculationStatus>
public enum JobGroupCalculationStatus extends Enum<JobGroupCalculationStatus> implements SchedulerEnumeration<JobGroupCalculationStatus>
Used to signal the dispatcher that a job group must be recalculated. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description InReschedulingThe recurrence is being rescheduled by the action worker.NoneNo recalculation necessary.PropagateFieldChangeA pre-submitted process was edited and changes were made on the recurrence.RecalculateNoRescheduleRecalculates recurrences, but does not start the rescheduling action processor.RecalculatePresubmittedJobDeletedA pre-submitted process was deleted after being canceled.RecalculateQueueThe process queue was changed.RecalculateSubmitFrameThe process submit frame was changed.RecalculateTimeWindowThe process time window was changed.
-
Field Summary
Fields Modifier and Type Field Description static charInReschedulingCodeThe char returned from InRescheduling.getCodeEx().static charNoneCodeThe char returned from None.getCodeEx().static charPropagateFieldChangeCodeThe char returned from PropagateFieldChange.getCodeEx().static charRecalculateNoRescheduleCodeThe char returned from RecalculateNoReschedule.getCodeEx().static charRecalculatePresubmittedJobDeletedCodeThe char returned from RecalculatePresubmittedJobDeleted.getCodeEx().static charRecalculateQueueCodeThe char returned from RecalculateQueue.getCodeEx().static charRecalculateSubmitFrameCodeThe char returned from RecalculateSubmitFrame.getCodeEx().static charRecalculateTimeWindowCodeThe char returned from RecalculateTimeWindow.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description chargetCodeEx()Get the code that is used to represent this enumeration in the database.CharactergetCodeExCharacter()Get the code that is used to represent this enumeration in the database.StringgetCodeExString()Get the code that is used to represent this enumeration in the database.CharactergetCodeExValue()Return the code for the enumeration item as the database type of this enumeration.StringgetDescriptionKey()Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.StringgetTranslationEN()Get the English name of this enumeration.StringgetTranslationKey()Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static JobGroupCalculationStatussafeValueOf(String value)Helper function to return the JobGroupCalculationStatus represented byvalue.static JobGroupCalculationStatusvalueOf(char code)Helper function to return the JobGroupCalculationStatus represented by code.static JobGroupCalculationStatusvalueOf(Character code)Helper function to return the JobGroupCalculationStatus represented by code.static JobGroupCalculationStatusvalueOf(String name)Returns the enum constant of this type with the specified name.static JobGroupCalculationStatusvalueOfCode(String code)Helper function to return the JobGroupCalculationStatus represented by code.static JobGroupCalculationStatus[]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
-
None
public static final JobGroupCalculationStatus None
No recalculation necessary. Default.
-
RecalculateNoReschedule
public static final JobGroupCalculationStatus RecalculateNoReschedule
Recalculates recurrences, but does not start the rescheduling action processor. Used to upgrade recurrences.
-
RecalculateQueue
public static final JobGroupCalculationStatus RecalculateQueue
The process queue was changed. Now the recurrence must be recalculated by the dispatcher.
-
RecalculateSubmitFrame
public static final JobGroupCalculationStatus RecalculateSubmitFrame
The process submit frame was changed. Now the recurrence must be recalculated by the dispatcher.
-
RecalculateTimeWindow
public static final JobGroupCalculationStatus RecalculateTimeWindow
The process time window was changed. Now the recurrence must be recalculated by the dispatcher.
-
RecalculatePresubmittedJobDeleted
public static final JobGroupCalculationStatus RecalculatePresubmittedJobDeleted
A pre-submitted process was deleted after being canceled. Now the recurrence must be recalculated by the dispatcher.
-
PropagateFieldChange
public static final JobGroupCalculationStatus PropagateFieldChange
A pre-submitted process was edited and changes were made on the recurrence. Now the recurrence must be rescheduled to propagate the changes to the other active processes in the recurrence.
-
InRescheduling
public static final JobGroupCalculationStatus InRescheduling
The recurrence is being rescheduled by the action worker.
-
-
Field Detail
-
NoneCode
public static final char NoneCode
The char returned from None.getCodeEx().- See Also:
None, Constant Field Values
-
RecalculateNoRescheduleCode
public static final char RecalculateNoRescheduleCode
The char returned from RecalculateNoReschedule.getCodeEx().- See Also:
RecalculateNoReschedule, Constant Field Values
-
RecalculateQueueCode
public static final char RecalculateQueueCode
The char returned from RecalculateQueue.getCodeEx().- See Also:
RecalculateQueue, Constant Field Values
-
RecalculateSubmitFrameCode
public static final char RecalculateSubmitFrameCode
The char returned from RecalculateSubmitFrame.getCodeEx().- See Also:
RecalculateSubmitFrame, Constant Field Values
-
RecalculateTimeWindowCode
public static final char RecalculateTimeWindowCode
The char returned from RecalculateTimeWindow.getCodeEx().- See Also:
RecalculateTimeWindow, Constant Field Values
-
RecalculatePresubmittedJobDeletedCode
public static final char RecalculatePresubmittedJobDeletedCode
The char returned from RecalculatePresubmittedJobDeleted.getCodeEx().
-
PropagateFieldChangeCode
public static final char PropagateFieldChangeCode
The char returned from PropagateFieldChange.getCodeEx().- See Also:
PropagateFieldChange, Constant Field Values
-
InReschedulingCode
public static final char InReschedulingCode
The char returned from InRescheduling.getCodeEx().- See Also:
InRescheduling, Constant Field Values
-
-
Method Detail
-
values
public static JobGroupCalculationStatus[] 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 (JobGroupCalculationStatus c : JobGroupCalculationStatus.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static JobGroupCalculationStatus 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 JobGroupCalculationStatus valueOfCode(String code)
Helper function to return the JobGroupCalculationStatus represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.- Parameters:
code- A string with one character that is one of the codes for JobGroupCalculationStatus- Returns:
- The JobGroupCalculationStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static JobGroupCalculationStatus safeValueOf(String value)
Helper function to return the JobGroupCalculationStatus represented byvalue. Ifvalueis null, or not a valid JobGroupCalculationStatus 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 JobGroupCalculationStatus corresponding to
value, or null, ifvalueis null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static JobGroupCalculationStatus valueOf(Character code)
Helper function to return the JobGroupCalculationStatus represented by code. If code is null, or not a valid JobGroupCalculationStatus code then this method will return null.- Parameters:
code- Character that is one of the codes for HandlerAction- Returns:
- The JobGroupCalculationStatus corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static JobGroupCalculationStatus valueOf(char code)
Helper function to return the JobGroupCalculationStatus represented by code. If code is not a valid JobGroupCalculationStatus code then this method will return null.- Parameters:
code- char that is one of the codes for HandlerAction- Returns:
- The JobGroupCalculationStatus corresponding to code, or null, if code is not a valid code
-
getCodeEx
public char getCodeEx()
Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
getCodeExin interfaceSchedulerEnumeration<JobGroupCalculationStatus>- Returns:
- the database code for the enumeration
-
getCodeExValue
public Character getCodeExValue()
Description copied from interface:BaseSchedulerEnumerationReturn the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValuein interfaceBaseSchedulerEnumeration<JobGroupCalculationStatus,Character>- Returns:
- the enumeration code
-
getCodeExCharacter
public Character getCodeExCharacter()
Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
getCodeExCharacterin interfaceSchedulerEnumeration<JobGroupCalculationStatus>- Returns:
- the database code for the enumeration
-
getTranslationKey
public String getTranslationKey()
Description copied from interface:BaseSchedulerEnumerationGet the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
getTranslationKeyin interfaceBaseSchedulerEnumeration<JobGroupCalculationStatus,Character>- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumerationGet the English name of this enumeration.- Specified by:
getTranslationENin interfaceBaseSchedulerEnumeration<JobGroupCalculationStatus,Character>- Returns:
- the English name of this enumeration.
-
getDescriptionKey
public String getDescriptionKey()
Description copied from interface:BaseSchedulerEnumerationGet the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
getDescriptionKeyin interfaceBaseSchedulerEnumeration<JobGroupCalculationStatus,Character>- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)to retrieve the translated description.
-
getCodeExString
public String getCodeExString()
Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
getCodeExStringin interfaceSchedulerEnumeration<JobGroupCalculationStatus>- Returns:
- the database code for the enumeration
-
-