com.helger.phive.api.executorset.status.IValidationExecutorSetStatus Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.phive.api.executorset.status;

import java.time.OffsetDateTime;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.datetime.PDTFactory;
import com.helger.commons.string.StringHelper;
import com.helger.diver.api.coord.DVRCoordinate;

/**
 * Defines the status of a VES.
 *
 * @author Philip Helger
 * @since 9.2.0
 */
public interface IValidationExecutorSetStatus
{
  /**
   * @return The date and time of the last modification of this status.
   *         Precision is limited to milliseconds. May never be
   *         null.
   */
  @Nonnull
  OffsetDateTime getStatusLastModification ();

  /**
   * @return The effective status type. May not be null.
   */
  @Nonnull
  EValidationExecutorStatusType getType ();

  /**
   * @return true if the status type is deprecated,
   *         false if not.
   */
  default boolean isDeprecated ()
  {
    return getType ().isDeprecated ();
  }

  default boolean hasValidFrom ()
  {
    return getValidFrom () != null;
  }

  /**
   * @return The date and time from which this artefact is valid. Precision is
   *         limited to milliseconds. May be null to indicate
   *         "since forever".
   */
  @Nullable
  OffsetDateTime getValidFrom ();

  default boolean hasValidTo ()
  {
    return getValidTo () != null;
  }

  /**
   * @return The date and time until which this artefact is valid. Precision is
   *         limited to milliseconds. May be null to indicate
   *         "forever".
   */
  @Nullable
  OffsetDateTime getValidTo ();

  default boolean isValidPerNow ()
  {
    return isValidPer (PDTFactory.getCurrentOffsetDateTime ());
  }

  default boolean isValidPer (@Nonnull final OffsetDateTime aDT)
  {
    if (hasValidFrom () && aDT.isBefore (getValidFrom ()))
      return false;
    if (hasValidTo () && aDT.isAfter (getValidTo ()))
      return false;
    return true;
  }

  default boolean hasDeprecationReason ()
  {
    return StringHelper.hasText (getDeprecationReason ());
  }

  /**
   * @return If this is deprecated, this field may contain a human readable
   *         description. May be null.
   */
  @Nullable
  String getDeprecationReason ();

  /**
   * @return true if a replacement VESID is present,
   *         false if not.
   */
  default boolean hasReplacementVESID ()
  {
    return getReplacementVESID () != null;
  }

  /**
   * @return The replacement VESID to be used. May be null. If this
   *         artefact is deprecated and a later version exists, the latest
   *         version is always considered the appropriate replacement. However
   *         if group ID or artefact ID changed, it needs to be explicitly
   *         provided here as a replacement VESID.
   */
  @Nullable
  DVRCoordinate getReplacementVESID ();

  @Nonnull
  @Nonempty
  @ReturnsMutableObject
  ICommonsList  historyItems ();

  @Nonnull
  @Nonempty
  @ReturnsMutableCopy
  ICommonsList  getAllHistoryItems ();
}