Package de.hybris.platform.cronjob.enums

Enum CronJobResult

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

    The result reports on how the CronJob's last run was.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ERROR
      Generated enum value for CronJobResult.ERROR declared at extension processing.
      FAILURE
      Generated enum value for CronJobResult.FAILURE declared at extension processing.
      SUCCESS
      Generated enum value for CronJobResult.SUCCESS declared at extension processing.
      UNKNOWN
      Generated enum value for CronJobResult.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 CronJobResult valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CronJobResult[] 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

      • SUCCESS

        public static final CronJobResult SUCCESS
        Generated enum value for CronJobResult.SUCCESS declared at extension processing.

        The CronJob was executed without running into any problems.

      • FAILURE

        public static final CronJobResult FAILURE
        Generated enum value for CronJobResult.FAILURE declared at extension processing.

        The CronJob has completed its run on schedule, but it was not successful for some reason. Unlike the 'ERROR' result, this indicates a planned completion of the CronJob. Check the CronJob's log for details.

      • ERROR

        public static final CronJobResult ERROR
        Generated enum value for CronJobResult.ERROR declared at extension processing.

        There was a problem during the CronJob's run (for example, the Java Virtual Machine was terminated or there was a system exception). Unlike the {literal}FAILURE{literal} status, this status indicates an uncontrolled termination of the CronJob. Check the CronJob's log for details.

      • UNKNOWN

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

        No result is available. Most probably the CronJob has never been started yet.

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

      • valueOf

        public static CronJobResult 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