org.opentcs.access.rmi.services.RemoteTCSObjectService 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.Set;
import java.util.function.Predicate;
import org.opentcs.access.rmi.ClientID;
import org.opentcs.components.kernel.services.TCSObjectService;
import org.opentcs.data.ObjectHistory;
import org.opentcs.data.TCSObject;
import org.opentcs.data.TCSObjectReference;

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

  // CHECKSTYLE:OFF
  > T fetchObject(
      ClientID clientId,
      Class clazz,
      TCSObjectReference ref
  )
      throws RemoteException;

  > T fetchObject(ClientID clientId, Class clazz, String name)
      throws RemoteException;

  > Set fetchObjects(ClientID clientId, Class clazz)
      throws RemoteException;

  > Set fetchObjects(
      ClientID clientId,
      Class clazz,
      Predicate predicate
  )
      throws RemoteException;

  void updateObjectProperty(
      ClientID clientId,
      TCSObjectReference ref,
      String key,
      String value
  )
      throws RemoteException;

  void appendObjectHistoryEntry(
      ClientID clientId,
      TCSObjectReference ref,
      ObjectHistory.Entry entry
  )
      throws RemoteException;
  // CHECKSTYLE:ON
}