NlsBundleApplicationRoot.java

package io.oasp.gastronomy.restaurant.general.common.api;

import javax.inject.Named;

import net.sf.mmm.util.nls.api.NlsBundle;
import net.sf.mmm.util.nls.api.NlsBundleMessage;
import net.sf.mmm.util.nls.api.NlsMessage;

/**
 * This is the {@link NlsBundle} for this application.
 *
 */
public interface NlsBundleApplicationRoot extends NlsBundle {

  /**
   * @see io.oasp.gastronomy.restaurant.general.common.api.exception.IllegalEntityStateException
   *
   * @param entity is the entity relevant for the error.
   * @param state is the state of the entity that caused the operation to fail.
   * @return the {@link NlsMessage}.
   */
  @NlsBundleMessage("The entity {entity} is in state {state}!")
  NlsMessage errorIllegalEntityState(@Named("entity") Object entity, @Named("state") Object state);

  /**
   * @see io.oasp.gastronomy.restaurant.general.common.api.exception.IllegalEntityStateException
   *
   * @param entity is the entity relevant for the error.
   * @param currentState is the current state of the entity.
   * @param newState is the new state for the entity that is illegal.
   * @return the {@link NlsMessage}.
   */
  @NlsBundleMessage("The entity {entity} in state {currentState} can not be changed to state {newState}!")
  NlsMessage errorIllegalEntityStateChange(@Named("entity") Object entity, @Named("currentState") Object currentState,
      @Named("newState") Object newState);

  /**
   * @see io.oasp.gastronomy.restaurant.general.common.api.exception.IllegalEntityStateException
   *
   * @param object is the entity relevant for the error.
   * @param property is the property of the entity that can not be changed.
   * @return the {@link NlsMessage}.
   */
  @NlsBundleMessage("The property {property} of object {object} can not be changed!")
  NlsMessage errorIllegalPropertyChange(@Named("object") Object object, @Named("property") Object property);

  /**
   * @see io.oasp.gastronomy.restaurant.general.common.api.exception.NoActiveUserException
   *
   * @return the {@link NlsMessage}.
   */
  @NlsBundleMessage("There is currently no user logged in")
  NlsMessage errorNoActiveUser();

  // BEGIN ARCHETYPE SKIP
  /**
   * @see io.oasp.gastronomy.restaurant.offermanagement.common.api.exception.OfferEmptyException
   *
   * @return the {@link NlsMessage}.
   */
  @NlsBundleMessage("The offer is empty - it must contain a drink, meal, or side-dish!")
  NlsMessage errorOfferEmpty();

  /**
   * @see io.oasp.gastronomy.restaurant.salesmanagement.common.api.exception.ChangeTableIllegalStateCombinationException
   *
   * @param orderId The id of the order which is going to be transfered to the targetTable
   * @param tableNumber of the targetTable which is causing the problem
   * @return the {@link NlsMessage}.
   */
  @NlsBundleMessage("The order with the Id {orderId} can''t be transfered to the table with the Number {tableNumber}"
      + " because this table is already occupied.")
  NlsMessage errorChangeTableIllegalStateCombination(@Named("orderId") Long orderId,
      @Named("tableNumber") Long tableNumber);
  // END ARCHETYPE SKIP

}