InternalPeripheralJobService (openTCS 5.4.0 Base API documentation)

All Superinterfaces:: PeripheralJobService, TCSObjectService

public interface InternalPeripheralJobService
extends PeripheralJobService

Declares the methods the peripheral job service must provide which are not accessible to remote peers.

Method Summary

Modifier and Type Method Description

void updatePeripheralJobState(TCSObjectReference<PeripheralJob> ref, PeripheralJob.State state)
Updates a peripheral job's state.

Methods inherited from interface org.opentcs.components.kernel.services.PeripheralJobService
createPeripheralJob

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

Method Details
- updatePeripheralJobState
  
  void updatePeripheralJobState(TCSObjectReference<PeripheralJob> ref, PeripheralJob.State state) throws ObjectUnknownException
  
  Updates a peripheral job's state. Note that peripheral job states are intended to be manipulated by the peripheral job dispatcher only. Calling this method from any other parts of the kernel may result in undefined behaviour.
  
  Parameters:
  
  ref - A reference to the peripheral job to be modified.
  
  state - The peripheral job's new state.
  
  Throws:
  
  ObjectUnknownException - If the referenced peripheral job does not exist.