com.ibm.commerce.subscription.commands

Enum ScheduleEvaluateCmd.UnitOfMeasure

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ScheduleEvaluateCmd.UnitOfMeasure>
    Enclosing interface:
    ScheduleEvaluateCmd

    public static enum ScheduleEvaluateCmd.UnitOfMeasure
extends java.lang.Enum<ScheduleEvaluateCmd.UnitOfMeasure>
    The unit of measures supported for frequency. It defines the units of measurement supported by default. The enumeration contains the name of the unit and the calendar field used to manipulate a date for this unit. The default units supported are:
    • Years - Calendar.YEAR
    • Months - Calendar.MONTH
    • Weeks - Calendar.WEEK_OF_YEAR
    • Days - Calendar.DATE
    • Hours - Calendar.HOUR

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright field.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Integer getCalendarField()
      This method returns the calendar field associated with the unit of measure.
      java.lang.String getName()
      This method returns the name of the unit
      java.lang.String getQuantityUnitId()
      This method the quantity unit ID in the QTYUNITTYPE table.
      static ScheduleEvaluateCmd.UnitOfMeasure valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ScheduleEvaluateCmd.UnitOfMeasure[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright field.
        See Also:
        Constant Field Values

    • Method Detail

      • values

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

      • valueOf

        public static ScheduleEvaluateCmd.UnitOfMeasure 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

      • getCalendarField

        public java.lang.Integer getCalendarField()
        This method returns the calendar field associated with the unit of measure.
        Returns:
        The calendar field to use.

      • getName

        public java.lang.String getName()
        This method returns the name of the unit
        Returns:
        The name of the unit

      • getQuantityUnitId

        public java.lang.String getQuantityUnitId()
        This method the quantity unit ID in the QTYUNITTYPE table.
        Returns:
        The quantity ID of the unit.
Skip navigation links