Module com.genologics.ri
Package com.genologics.ri.step

Class ProcessStep

java.lang.Object
com.genologics.ri.step.ProcessStep
All Implemented Interfaces:
LimsEntity<ProcessStep>, LimsEntityLinkable<ProcessStep>, Linkable<ProcessStep>, Locatable, Serializable
public class ProcessStep extends Object implements LimsEntity<ProcessStep>, Serializable
The detailed representation of a step.

Since API version 2.27, the step can be deleted to cancel a process. Requires the current status of step to be "in progress".

See Also:

  • Field Details

    • dateStarted

      protected Date dateStarted
      The date and time the step was started.
      Since:
      2.22

    • dateCompleted

      protected Date dateCompleted
      The date and time the step was completed.
      Since:
      2.22

    • configuration

      protected StepConfiguration configuration
      The configuration of the step.

    • actions

      protected ActionsLink actions
      Link to the actions associated with this step.

    • reagents

      protected ReagentsLink reagents
      Link to the reagents associated with this step.

    • pools

      protected PoolsLink pools
      Link to the pools associated with this step.

    • placements

      protected PlacementsLink placements
      Link to the placements associated with this step.

    • reagentLots

      protected ReagentLotsLink reagentLots
      Link to the reagent lots associated with this step.
      Since:
      2.18

    • programStatus

      protected ProgramStatusLink programStatus
      Link to the program status associated with this step.

    • setup

      protected StepSetupLink setup
      Link to the setup associated with this step.
      Since:
      2.18

    • arrangements

      protected ArrangementsLink arrangements
      Link to the arrangements associated with this step.
      Since:
      2.34

    • details

      protected StepDetailsLink details
      Link to the details associated with this step.
      Since:
      2.18

    • availablePrograms

      protected List<AvailableProgram> availablePrograms
      The list of programs available for this step.
      Since:
      2.18

    • automaticNextStep

      protected AutomaticNextStepLink automaticNextStep
      Link to the next step that will be automatically triggered after this step.
      Since:
      2.22

    • technician

      protected Technician technician
      The technician assigned to this step.
      Since:
      2.34

    • uri

      protected URI uri
      The URI of the step.

    • limsid

      protected String limsid
      The LIMS id of the step.

    • currentState

      protected ProcessState currentState
      The current state of the step. Now an enumeration since release 2.31.3 of the client.
      Since:
      2.18

  • Constructor Details

    • ProcessStep

      public ProcessStep()
      Constructs a new empty ProcessStep.

    • ProcessStep

      public ProcessStep(URI uri)
      Constructs a new ProcessStep with the given URI.
      Parameters:
      uri - the URI of the step.

    • ProcessStep

      public ProcessStep(URI uri, String limsid)
      Constructs a new ProcessStep with the given URI and LIMS id.
      Parameters:
      uri - the URI of the step.
      limsid - the LIMS id of the step.

  • Method Details

    • getDateStarted

      public Date getDateStarted()
      Gets the date and time the step was started.
      Returns:
      the start date.

    • setDateStarted

      public void setDateStarted(Date dateStarted)
      Sets the date and time the step was started.
      Parameters:
      dateStarted - the start date.

    • getDateCompleted

      public Date getDateCompleted()
      Gets the date and time the step was completed.
      Returns:
      the completion date.

    • setDateCompleted

      public void setDateCompleted(Date dateCompleted)
      Sets the date and time the step was completed.
      Parameters:
      dateCompleted - the completion date.

    • getConfiguration

      public StepConfiguration getConfiguration()
      Gets the configuration of the step.
      Returns:
      the step configuration.

    • setConfiguration

      public void setConfiguration(StepConfiguration configuration)
      Sets the configuration of the step.
      Parameters:
      configuration - the step configuration.

    • getActions

      public ActionsLink getActions()
      Gets the link to the actions associated with this step.
      Returns:
      the actions link.

    • setActions

      public void setActions(ActionsLink actions)
      Sets the link to the actions associated with this step.
      Parameters:
      actions - the actions link.

    • getReagents

      public ReagentsLink getReagents()
      Gets the link to the reagents associated with this step.
      Returns:
      the reagents link.

    • setReagents

      public void setReagents(Linkable<Reagents> reagents)
      Sets the link to the reagents associated with this step.
      Parameters:
      reagents - the linkable reagents.

    • getPools

      public PoolsLink getPools()
      Gets the link to the pools associated with this step.
      Returns:
      the pools link.

    • setPools

      public void setPools(Linkable<Pools> pools)
      Sets the link to the pools associated with this step.
      Parameters:
      pools - the linkable pools.

    • getPlacements

      public PlacementsLink getPlacements()
      Gets the link to the placements associated with this step.
      Returns:
      the placements link.

    • setPlacements

      public void setPlacements(Linkable<Placements> placements)
      Sets the link to the placements associated with this step.
      Parameters:
      placements - the linkable placements.

    • getProgramStatus

      public ProgramStatusLink getProgramStatus()
      Gets the link to the program status associated with this step.
      Returns:
      the program status link.

    • setProgramStatus

      public void setProgramStatus(Linkable<ProgramStatus> programStatus)
      Sets the link to the program status associated with this step.
      Parameters:
      programStatus - the linkable program status.

    • getUri

      public URI getUri()
      Gets the URI of the step.
      Specified by:
      getUri in interface Locatable
      Returns:
      the URI.

    • setUri

      public void setUri(URI uri)
      Sets the URI of the step.
      Specified by:
      setUri in interface Locatable
      Parameters:
      uri - the URI.

    • getLimsid

      public String getLimsid()
      Gets the LIMS id of the step.
      Specified by:
      getLimsid in interface LimsEntityLinkable<ProcessStep>
      Returns:
      the LIMS id.

    • setLimsid

      public void setLimsid(String limsid)
      Sets the LIMS id of the step.
      Specified by:
      setLimsid in interface LimsEntityLinkable<ProcessStep>
      Parameters:
      limsid - the LIMS id.

    • getReagentLots

      public ReagentLotsLink getReagentLots()
      Gets the link to the reagent lots associated with this step.
      Returns:
      the reagent lots link.

    • setReagentLots

      public void setReagentLots(Linkable<ReagentLots> link)
      Sets the link to the reagent lots associated with this step.
      Parameters:
      link - the linkable reagent lots.

    • getSetup

      public StepSetupLink getSetup()
      Gets the link to the setup associated with this step.
      Returns:
      the setup link.

    • setSetup

      public void setSetup(Linkable<StepSetup> link)
      Sets the link to the setup associated with this step.
      Parameters:
      link - the linkable setup.

    • getStepDetails

      public StepDetailsLink getStepDetails()
      Gets the link to the details associated with this step.
      Returns:
      the details link.

    • setDetails

      public void setDetails(Linkable<StepDetails> link)
      Sets the link to the details associated with this step.
      Parameters:
      link - the linkable details.

    • getArrangements

      public ArrangementsLink getArrangements()
      Gets the link to the arrangements associated with this step.
      Returns:
      the arrangements link.

    • setArrangements

      public void setArrangements(Linkable<Arrangements> arrangements)
      Sets the link to the arrangements associated with this step.
      Parameters:
      arrangements - the linkable arrangements.

    • getAvailablePrograms

      public List<AvailableProgram> getAvailablePrograms()
      Gets the list of programs available for this step. The list will be created if it does not already exist.
      Returns:
      the list of available programs.

    • addAvailableProgram

      public AvailableProgram addAvailableProgram(AvailableProgram ap)
      Adds an available program to the list of programs for this step.
      Parameters:
      ap - the available program to add.
      Returns:
      the added available program.

    • getCurrentState

      public ProcessState getCurrentState()
      Gets the current state of the step.
      Returns:
      the current state.

    • setCurrentState

      public void setCurrentState(ProcessState currentState)
      Sets the current state of the step.
      Parameters:
      currentState - the current state.

    • getAutomaticNextStep

      public AutomaticNextStepLink getAutomaticNextStep()
      Gets the link to the next step that will be automatically triggered after this step.
      Returns:
      the automatic next step link.

    • setAutomaticNextStep

      public void setAutomaticNextStep(Linkable<ProcessStep> step)
      Sets the link to the next step that will be automatically triggered after this step.
      Parameters:
      step - the linkable next step.

    • getTechnician

      public Technician getTechnician()
      Gets the technician assigned to this step.
      Returns:
      the technician.

    • setTechnician

      public void setTechnician(Linkable<Researcher> technician)
      Sets the technician assigned to this step from a linkable researcher.
      Parameters:
      technician - the linkable researcher.

    • setTechnician

      public void setTechnician(Researcher technician)
      Sets the technician assigned to this step from a researcher.
      Parameters:
      technician - the researcher.

    • setTechnician

      public void setTechnician(Technician technician)
      Sets the technician assigned to this step.
      Parameters:
      technician - the technician.

    • getLink

      public LimsEntityLink<ProcessStep> getLink()
      Get a concrete link object to this LimsEntityLinkable entity. This definition simply narrows the type of links returned by classes that implement this interface, as they should all have corresponding LimsEntityLink link classes available.
      Specified by:
      getLink in interface LimsEntityLinkable<ProcessStep>
      Specified by:
      getLink in interface Linkable<ProcessStep>
      Returns:
      A LimsEntityLink to this object.