org.opentcs.access.rmi.services.RemoteDispatcherService 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.access.rmi.services;

import java.rmi.Remote;
import java.rmi.RemoteException;
import org.opentcs.access.rmi.ClientID;
import org.opentcs.components.kernel.services.DispatcherService;
import org.opentcs.data.TCSObjectReference;
import org.opentcs.data.model.Vehicle;
import org.opentcs.data.order.ReroutingType;
import org.opentcs.data.order.TransportOrder;

/**
 * Declares the methods provided by the {@link DispatcherService} via RMI.
 *
 * 
 * The majority of the methods declared here have signatures analogous to their counterparts in
 * {@link DispatcherService}, with an additional {@link ClientID} parameter which serves the purpose
 * of identifying the calling client and determining its permissions.
 * 
 * 
 * To avoid redundancy, the semantics of methods that only pass through their arguments are not
 * explicitly documented here again. See the corresponding API documentation in
 * {@link DispatcherService} for these, instead.
 * 
 */
public interface RemoteDispatcherService
    extends
      Remote {

  // CHECKSTYLE:OFF
  void dispatch(ClientID clientId)
      throws RemoteException;

  void withdrawByVehicle(
      ClientID clientId,
      TCSObjectReference ref,
      boolean immediateAbort
  )
      throws RemoteException;

  void withdrawByTransportOrder(
      ClientID clientId,
      TCSObjectReference ref,
      boolean immediateAbort
  )
      throws RemoteException;

  void reroute(ClientID clientId, TCSObjectReference ref, ReroutingType reroutingType)
      throws RemoteException;

  void rerouteAll(ClientID clientId, ReroutingType reroutingType)
      throws RemoteException;

  void assignNow(ClientID clientId, TCSObjectReference ref)
      throws RemoteException;
  // CHECKSTYLE:ON
}