org.opentcs.access.rmi.services.RemotePlantModelService 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 java.util.Map;
import org.opentcs.access.rmi.ClientID;
import org.opentcs.access.to.model.PlantModelCreationTO;
import org.opentcs.components.kernel.services.PlantModelService;
import org.opentcs.data.TCSObjectReference;
import org.opentcs.data.model.Location;
import org.opentcs.data.model.Path;
import org.opentcs.data.model.PlantModel;

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

  // CHECKSTYLE:OFF
  PlantModel getPlantModel(ClientID clientId)
      throws RemoteException;

  void createPlantModel(ClientID clientId, PlantModelCreationTO to)
      throws RemoteException;

  String getModelName(ClientID clientId)
      throws RemoteException;

  Map getModelProperties(ClientID clientId)
      throws RemoteException;

  void updateLocationLock(ClientID clientId, TCSObjectReference ref, boolean locked)
      throws RemoteException;

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