PeripheralJobService (openTCS 5.4.0 Base API documentation)

All Superinterfaces:: TCSObjectService

All Known Subinterfaces:: InternalPeripheralJobService

public interface PeripheralJobService
extends TCSObjectService

Provides methods concerning PeripheralJobs.

Method Summary

Modifier and Type Method Description

PeripheralJob createPeripheralJob(PeripheralJobCreationTO to)
Creates a peripheral job.

Methods inherited from interface org.opentcs.components.kernel.services.TCSObjectService
appendObjectHistoryEntry, fetchObject, fetchObject, fetchObjects, fetchObjects, updateObjectProperty

Method Details
- createPeripheralJob
  
  PeripheralJob createPeripheralJob(PeripheralJobCreationTO to) throws ObjectUnknownException, ObjectExistsException, KernelRuntimeException
  
  Creates a peripheral job. A new peripheral job is created with a generated unique ID and all other attributes taken from the given transfer object. A copy of the newly created transport order is then returned.
  
  Parameters:
  
  to - Describes the peripheral job to be created.
  
  Returns:
  
  A copy of the newly created peripheral job.
  
  Throws:
  
  ObjectUnknownException - If any referenced object does not exist.
  
  ObjectExistsException - If an object with the same name already exists in the model.
  
  KernelRuntimeException - In case there is an exception executing this method.