Module com.genologics.ri
Package com.genologics.ri.processtemplate

Class ProcessTemplate

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

  • Field Details

    • name

      protected String name
      The name of this process template.

    • processType

      protected ProcessTypeLink processType
      The process type this template is associated with.

    • technician

      protected Technician technician
      The technician configured to run processes created from this template.

    • instrument

      protected InstrumentLink instrument
      The instrument configured to run processes created from this template.

    • parameter

      protected Parameter parameter
      The process parameter for external program integration.

    • type

      protected UDT type
      The user-defined type.

    • fields

      protected List<UDF> fields
      The user-defined fields.

    • defaultTemplate

      protected Boolean defaultTemplate
      Indicates whether this is the default template for the associated process type.

    • uri

      protected URI uri
      The URI of this process template.

  • Constructor Details

    • ProcessTemplate

      public ProcessTemplate()
      Default constructor.

    • ProcessTemplate

      public ProcessTemplate(URI uri)
      Constructor with URI.
      Parameters:
      uri - the URI of the process template.

    • ProcessTemplate

      public ProcessTemplate(URI uri, String name)
      Constructor with URI and name.
      Parameters:
      uri - the URI of the process template.
      name - the name of the process template.

  • Method Details

    • getUri

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

    • setUri

      public void setUri(URI value)
      Sets the URI.
      Specified by:
      setUri in interface Locatable
      Parameters:
      value - the URI to set.

    • getName

      public String getName()
      Gets the name.
      Returns:
      the name.

    • setName

      public void setName(String name)
      Sets the name.
      Parameters:
      name - the name to set.

    • getProcessType

      public ProcessTypeLink getProcessType()
      Gets the process type link.
      Returns:
      the process type link.

    • setProcessType

      public void setProcessType(ProcessTypeLink processType)
      Sets the process type.
      Parameters:
      processType - the process type link to set.

    • setProcessType

      public void setProcessType(ProcessType processType)
      Sets the process type from a ProcessType object.
      Parameters:
      processType - the process type to set.

    • getTechnician

      public Technician getTechnician()
      Gets the technician.
      Returns:
      the technician.

    • setTechnician

      public void setTechnician(Technician technician)
      Sets the technician.
      Parameters:
      technician - the technician to set.

    • setTechnician

      public void setTechnician(Researcher researcher)
      Sets the technician from a Researcher object.
      Parameters:
      researcher - the researcher to set as technician.

    • getInstrument

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

    • setInstrument

      public void setInstrument(InstrumentLink instrument)
      Sets the instrument.
      Parameters:
      instrument - the instrument link to set.

    • setInstrument

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

    • getParameter

      public Parameter getParameter()
      Gets the parameter.
      Returns:
      the parameter.

    • setParameter

      public void setParameter(Parameter parameter)
      Sets the parameter.
      Parameters:
      parameter - the parameter to set.

    • getUserDefinedType

      public UDT getUserDefinedType()
      Gets the user-defined type.
      Returns:
      the user-defined type.

    • setUserDefinedType

      public UDT setUserDefinedType(UDT value)
      Sets the user-defined type.
      Parameters:
      value - the user-defined type to set.
      Returns:
      the user-defined type that was set.

    • setUserDefinedType

      public UDT setUserDefinedType(String type)
      Sets the user-defined type by name.
      Parameters:
      type - the name of the user-defined type.
      Returns:
      the created user-defined type.

    • getUserDefinedFields

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

    • isDefault

      public Boolean isDefault()
      Checks if this is the default template.
      Returns:
      true if this is the default template, false otherwise.

    • setDefault

      public void setDefault(Boolean defaultTemplate)
      Sets whether this is the default template.
      Parameters:
      defaultTemplate - true to make this the default template.

    • getLink

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