Package de.elo.ix.client.subs

Class SubstitutionPeriod

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.subs.SubstitutionPeriod
All Implemented Interfaces:
Serializable
public class SubstitutionPeriod extends ValueClass
A substitution period is used to define time periods for substitutions.

A substitution is automatically activated during a time period if SubstitutionSettings.activatePeriodsAutomatically is set to true.

A time period always needs a start date, this date must not be in the past. The earliest start date is the current day to start a substitution immediately.
The end date can be set, then the last day of the substitution is the end date (inclusive). It can also be left empty to have an open end for a substitution.

A active substitution based on a time period can only be disabled by deleting the corresponding SubstitutionPeriod.

Since:
12.00.000.002
See Also:

  • Field Details

    • substitutionGuid

      protected String substitutionGuid
      GUID of the corresponding Substitution. Read-only.
      Since:
      12.00.000.002

    • startIsodate

      protected String startIsodate

      Start date of a substitution period (inclusive)

      A start date must always be set.

      Date format must be either 'yyyyMMdd' or 'yyyyMMddHHmmss'. If only a date ('yyyyMMdd') is provided, it is adjusted to 'yyyyMMdd000000' to match the beginning of a day.

      Dates are always committed and returned in the client's time zone.

    • endIsodate

      protected String endIsodate

      End date of a substitution period (inclusive).

      If this value if empty, the substitution never ends.

      Date format must be either 'yyyyMMdd' or 'yyyyMMddHHmmss'. If only a date ('yyyyMMdd') is provided, it is adjusted to 'yyyyMMdd235959' to match the end of a day.

      Dates are always committed and returned in the client's time zone.

  • Constructor Details

    • SubstitutionPeriod

      public SubstitutionPeriod()

    • SubstitutionPeriod

      public SubstitutionPeriod(SubstitutionPeriod rhs)

  • Method Details

    • getStartIsodate

      public String getStartIsodate()

    • setStartIsodate

      public void setStartIsodate(String startIsodate)

    • getEndIsodate

      public String getEndIsodate()

    • setEndIsodate

      public void setEndIsodate(String endIsodate)

    • getSubstitutionGuid

      public String getSubstitutionGuid()

    • setSubstitutionGuid

      public void setSubstitutionGuid(String substitutionGuid)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object