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

Class StepDetails

java.lang.Object
com.genologics.ri.step.StepDetails
All Implemented Interfaces:
Linkable<StepDetails>, Locatable, UDFHolder, Serializable
public class StepDetails extends Object implements Linkable<StepDetails>, UDFHolder, Serializable
Represents the detailed view of a step, including configuration, input/output mappings, user-defined fields, and associated resources.
Since:
2.18
See Also:

  • Field Details

    • step

      protected Link step
      Link to the step this details object describes.

    • configuration

      protected StepConfiguration configuration
      The configuration of the step.

    • inputOutputMaps

      protected List<InputOutputMap> inputOutputMaps
      The list of input to output artifact mappings for the step.

    • fields

      protected List<UDF> fields
      The user-defined fields for the step.

    • preset

      protected String preset
      The name of the preset configuration used for the step.

    • instrument

      protected InstrumentLink instrument
      Link to the instrument used for the step.

    • uri

      protected URI uri
      The URI of this step details resource.

  • Constructor Details

    • StepDetails

      public StepDetails()
      Default constructor.

    • StepDetails

      public StepDetails(URI uri)
      Constructor taking the URI of the step details.
      Parameters:
      uri - The URI of the step details.

  • Method Details

    • getStep

      public Link getStep()
      Gets the link to the step.
      Returns:
      The step link.

    • setStep

      public void setStep(Link step)
      Sets the link to the step.
      Parameters:
      step - The step link.

    • getConfiguration

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

    • setConfiguration

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

    • getInputOutputMaps

      public List<InputOutputMap> getInputOutputMaps()
      Gets the list of input to output artifact mappings.
      Returns:
      The list of input/output mappings.

    • addInputOutputMap

      public InputOutputMap addInputOutputMap(InputOutputMap iomap)
      Adds an input/output mapping to the step.
      Parameters:
      iomap - The input/output mapping to add.
      Returns:
      The added mapping.

    • addInputOutputMap

      public InputOutputMap addInputOutputMap(LimsEntityLinkable<Artifact> input, LimsEntityLinkable<Artifact> output)
      Creates and adds an input/output mapping to the step.
      Parameters:
      input - The input artifact.
      output - The output artifact.
      Returns:
      The created and added mapping.

    • getUserDefinedFields

      public List<UDF> getUserDefinedFields()
      Gets the list of user-defined fields for the step.
      Specified by:
      getUserDefinedFields in interface UDFHolder
      Returns:
      The list of user-defined fields.

    • getPreset

      public String getPreset()
      Gets the preset name.
      Returns:
      The preset name.

    • setPreset

      public void setPreset(String preset)
      Sets the preset name.
      Parameters:
      preset - The preset name.

    • getInstrument

      public InstrumentLink getInstrument()
      Gets the link to the instrument.
      Returns:
      The instrument link.

    • setInstrument

      public void setInstrument(Linkable<Instrument> link)
      Sets the instrument from a link.
      Parameters:
      link - The instrument link.

    • setInstrument

      public void setInstrument(Instrument instrument)
      Sets the instrument from an instrument object.
      Parameters:
      instrument - The instrument.

    • getUri

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

    • setUri

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

    • getLink

      public LimsLink<StepDetails> getLink()
      Get a concrete link object to this Linkable thing.
      Specified by:
      getLink in interface Linkable<StepDetails>
      Returns:
      A LimsLink to this object.