org.opentcs.data.order.OrderSequenceHistoryCodes Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-api-base Show documentation

opentcs-api-base

There is a newer version: 6.4.0

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.data.order;

/**
 * Defines constants for basic history event codes related to {@link OrderSequence}s and documents
 * how the respective supplementary information is to be interpreted.
 */
public interface OrderSequenceHistoryCodes {

  /**
   * An event code indicating a order sequence has been created.
   * 
   * The history entry's supplement is empty.
   * 
   */
  String SEQUENCE_CREATED = "tcs:history:sequenceCreated";

  /**
   * An event code indicating a transport order has been appended to an order sequence.
   * 
   * The history entry's supplement contains the name of the transport order that was appended.
   * 
   */
  String SEQUENCE_ORDER_APPENDED = "tcs:history:sequenceOrderAppended";

  /**
   * An event code indicating an order sequence's processing vehicle changed.
   * 
   * The history entry's supplement contains the name of the new processing vehicle, or the empty
   * string, if the processing vehicle was unset.
   * 
   */
  String SEQUENCE_PROCESSING_VEHICLE_CHANGED = "tcs:history:sequenceProcVehicleChanged";

  /**
   * An event code indicating an order sequence has been completed and will not be extended by more
   * orders.
   * 
   * The history entry's supplement is empty.
   * 
   */
  String SEQUENCE_COMPLETED = "tcs:history:sequenceCompleted";

  /**
   * An event code indicating an order sequence has been processed completely.
   * 
   * The history entry's supplement is empty.
   * 
   */
  String SEQUENCE_FINISHED = "tcs:history:sequenceFinished";

}