org.opentcs.access.rmi.services.RemotePeripheralJobService Maven / Gradle / Ivy

Go to download
// SPDX-FileCopyrightText: The openTCS Authors
// SPDX-License-Identifier: MIT
package org.opentcs.access.rmi.services;

import java.rmi.Remote;
import java.rmi.RemoteException;
import org.opentcs.access.rmi.ClientID;
import org.opentcs.access.to.peripherals.PeripheralJobCreationTO;
import org.opentcs.components.kernel.services.PeripheralJobService;
import org.opentcs.data.peripherals.PeripheralJob;

/**
 * Declares the methods provided by the {@link PeripheralJobService} via RMI.
 *
 * 
 * The majority of the methods declared here have signatures analogous to their counterparts in
 * {@link PeripheralJobService}, 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 PeripheralJobService} for these, instead.
 * 
 */
public interface RemotePeripheralJobService
    extends
      RemoteTCSObjectService,
      Remote {

  // CHECKSTYLE:OFF
  PeripheralJob createPeripheralJob(ClientID clientId, PeripheralJobCreationTO to)
      throws RemoteException;
  // CHECKSTYLE:ON
}