Package de.hybris.platform.cronjob.enums

Enum CronJobStatus

  • All Implemented Interfaces:
    HybrisEnumValue, java.io.Serializable, java.lang.Comparable<CronJobStatus>
    public enum CronJobStatus
extends java.lang.Enum<CronJobStatus>
implements HybrisEnumValue
    Generated enum CronJobStatus declared at extension processing.

    The status indicates the condition which the CronJob is in.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ABORTED
      Generated enum value for CronJobStatus.ABORTED declared at extension processing.
      FINISHED
      Generated enum value for CronJobStatus.FINISHED declared at extension processing.
      PAUSED
      Generated enum value for CronJobStatus.PAUSED declared at extension processing.
      RUNNING
      Generated enum value for CronJobStatus.RUNNING declared at extension processing.
      RUNNINGRESTART
      Generated enum value for CronJobStatus.RUNNINGRESTART declared at extension processing.
      UNKNOWN
      Generated enum value for CronJobStatus.UNKNOWN declared at extension processing.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String SIMPLE_CLASSNAME
      Generated simple class name constant.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCode()
      Gets the code of this enum value.
      java.lang.String getType()
      Gets the type this enum value belongs to.
      static CronJobStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CronJobStatus[] 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

      • RUNNINGRESTART

        public static final CronJobStatus RUNNINGRESTART
        Generated enum value for CronJobStatus.RUNNINGRESTART declared at extension processing.

        The CronJob's execution has previously been canceled, so it has been restarted and is currently still running.

      • RUNNING

        public static final CronJobStatus RUNNING
        Generated enum value for CronJobStatus.RUNNING declared at extension processing.

        The CronJob is being executed right now.

      • PAUSED

        public static final CronJobStatus PAUSED
        Generated enum value for CronJobStatus.PAUSED declared at extension processing.

        The CronJob's execution has been interrupted in its execution, either automatically by a piece of business logic or manually by user intervention. You will need to resume the CronJob's execution if you want it to finish its run.

      • FINISHED

        public static final CronJobStatus FINISHED
        Generated enum value for CronJobStatus.FINISHED declared at extension processing.

        The CronJob has completed its run.

      • ABORTED

        public static final CronJobStatus ABORTED
        Generated enum value for CronJobStatus.ABORTED declared at extension processing.

        The CronJob's execution has been cancelled - either due to an error or due to user intervention. Check the CronJob's log for details.

      • UNKNOWN

        public static final CronJobStatus UNKNOWN
        Generated enum value for CronJobStatus.UNKNOWN declared at extension processing.

        Most probably, a CronJob in this state has never been run before.

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • SIMPLE_CLASSNAME

        public static final java.lang.String SIMPLE_CLASSNAME
        Generated simple class name constant.
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static CronJobStatus[] 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 (CronJobStatus c : CronJobStatus.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CronJobStatus valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getCode

        public java.lang.String getCode()
        Gets the code of this enum value.
        Specified by:
        getCode in interface HybrisEnumValue
        Returns:
        code of value

      • getType

        public java.lang.String getType()
        Gets the type this enum value belongs to.
        Specified by:
        getType in interface HybrisEnumValue
        Returns:
        code of type