Module com.genologics.ri
Package com.genologics.ri.processtype

Class Parameter

java.lang.Object
com.genologics.ri.processtype.Parameter
All Implemented Interfaces:
Serializable
public class Parameter extends Object implements Serializable
The parameter element integrates the process with the External Program Integration plug-in (EPP). When a user runs the process, the system automatically issue a command, or submits files and scripts to third-party programs for further processing. The parameter element is a child element of process-type.
See Also:

  • Field Details

    • file

      @Deprecated protected String file
      Deprecated.
      This property is no longer supported.
      The file of the parameter.

    • script

      protected String script
      The EPP script text that will actually run.

    • runProgramPerEvent

      @Deprecated protected Boolean runProgramPerEvent
      Deprecated.
      This property is no longer supported.
      Whether the EPP should run once for each process-related event.

    • channel

      protected String channel
      The channel on which the EPP runs.

    • invocationType

      @Deprecated protected InvocationType invocationType
      Deprecated.
      This property is no longer supported.
      The invocation type of the EPP.

    • files

      protected List<ClarityFile> files
      Files associated with this parameter.
      Since:
      2.26

    • name

      protected String name
      The name of the parameter.

  • Constructor Details

    • Parameter

      public Parameter()

  • Method Details

    • getFile

      @Deprecated public String getFile()
      Deprecated.
      This property is no longer supported.
      The file of the parameter.
      Returns:
      The file name (presumably).

    • setFile

      @Deprecated public void setFile(String file)
      Deprecated.
      This property is no longer supported.
      Sets the file of the parameter.
      Parameters:
      file - the file name.

    • getScript

      public String getScript()
      Gets the EPP script text that will actually run.
      Returns:
      the script text.

    • setScript

      public void setScript(String script)
      Sets the EPP script text that will actually run.
      Parameters:
      script - the script text.

    • isRunProgramPerEvent

      @Deprecated public Boolean isRunProgramPerEvent()
      Deprecated.
      This property is no longer supported.
      Should the EPP run once for each process related event?
      Returns:
      true if it should run once per event, false if not.

    • setRunProgramPerEvent

      @Deprecated public void setRunProgramPerEvent(Boolean runProgramPerEvent)
      Deprecated.
      This property is no longer supported.
      Sets whether the EPP should run once for each process related event.
      Parameters:
      runProgramPerEvent - true if it should run once per event.

    • getChannel

      public String getChannel()
      Gets the channel on which the EPP runs.
      Returns:
      the channel.

    • setChannel

      public void setChannel(String channel)
      Sets the channel on which the EPP runs.
      Parameters:
      channel - the channel.

    • getInvocationType

      @Deprecated public InvocationType getInvocationType()
      Deprecated.
      This property is no longer supported.
      The epp invocation type of this script.
      Returns:
      The invocation type.

    • setInvocationType

      @Deprecated public void setInvocationType(InvocationType invocationType)
      Deprecated.
      This property is no longer supported.
      Sets the epp invocation type of this script.
      Parameters:
      invocationType - the invocation type.

    • getName

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

    • setName

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

    • getFiles

      public List<ClarityFile> getFiles()
      Each File provides a URI linking to the detailed representation of a File associated with the Process Parameter.
      Returns:
      A list of files.
      Since:
      2.26