Module com.genologics.ri
Package com.genologics.ri.workflowconfiguration

Class Workflow

java.lang.Object
com.genologics.ri.workflowconfiguration.Workflow
All Implemented Interfaces:
Linkable<Workflow>, Locatable, Serializable
public class Workflow extends Object implements Linkable<Workflow>, Serializable
The detailed representation of a Workflow.
See Also:

  • Field Details

    • ID_EXTRACTOR_PATTERN

      public static final Pattern ID_EXTRACTOR_PATTERN
      Regular expression to extract workflow id from a workflow URI.
      Since:
      2.22

    • protocols

      protected List<ProtocolLink> protocols
      The list of protocols associated with this workflow.

    • stages

      protected List<StageLink> stages
      The list of stages associated with this workflow.

    • name

      protected String name
      The name of the workflow.

    • uri

      protected URI uri
      The URI of the workflow.

    • status

      protected Status status
      The status of the workflow.

  • Constructor Details

    • Workflow

      public Workflow()
      Default constructor.

    • Workflow

      public Workflow(URI uri)
      Constructor accepting a URI.
      Parameters:
      uri - The workflow URI.

    • Workflow

      public Workflow(URI uri, String name)
      Constructor accepting a URI and name.
      Parameters:
      uri - The workflow URI.
      name - The workflow name.

  • Method Details

    • getId

      public Integer getId()
      Get the numeric identifier for this workflow from its URI.
      Returns:
      The workflow id, or null if either the URI is not set or it doesn't match the form expected for a workflow URI.
      Since:
      2.22

    • getName

      public String getName()
      Gets the name of the workflow.
      Returns:
      The workflow name.

    • setName

      public void setName(String name)
      Sets the name of the workflow.
      Parameters:
      name - The workflow name.

    • getUri

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

    • setUri

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

    • getStatus

      public Status getStatus()
      Gets the status of the workflow.
      Returns:
      The workflow status.

    • setStatus

      public void setStatus(Status status)
      Sets the status of the workflow.
      Parameters:
      status - The workflow status.

    • getProtocols

      public List<ProtocolLink> getProtocols()
      Gets the list of protocols associated with this workflow.
      Returns:
      The list of protocol links.

    • addProtocol

      public ProtocolLink addProtocol(Linkable<Protocol> protocol)
      Adds a protocol to this workflow.
      Parameters:
      protocol - The protocol to add.
      Returns:
      The newly created protocol link.

    • getStages

      public List<StageLink> getStages()
      Gets the list of stages associated with this workflow.
      Returns:
      The list of stage links.

    • addStage

      public StageLink addStage(Linkable<Stage> stage)
      Adds a stage to this workflow.
      Parameters:
      stage - The stage to add.
      Returns:
      The newly created stage link.

    • getLink

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