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:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	channel
protected String	file	Deprecated.
protected List<ClarityFile>	files
protected InvocationType	invocationType	Deprecated.
protected String	name
protected Boolean	runProgramPerEvent	Deprecated.
protected String	script	The EPP script text that will actually run.

Constructor Summary

Constructors

Constructor	Description
Parameter()

Method Summary

Modifier and Type	Method	Description
String	getChannel()
String	getFile()	Deprecated. This property is no longer supported.
List<ClarityFile>	getFiles()	Each File provides a URI linking to the detailed representation of a File associated with the Process Parameter.
InvocationType	getInvocationType()	Deprecated. This property is no longer supported.
String	getName()
String	getScript()
Boolean	isRunProgramPerEvent()	Deprecated. This property is no longer supported.
void	setChannel(String channel)
void	setFile(String file)	Deprecated.
void	setInvocationType(InvocationType invocationType)	Deprecated.
void	setName(String name)
void	setRunProgramPerEvent(Boolean runProgramPerEvent)	Deprecated.
void	setScript(String script)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

file

@Deprecated
protected String file

Deprecated.

script

protected String script

The EPP script text that will actually run.

runProgramPerEvent

@Deprecated
protected Boolean runProgramPerEvent

Deprecated.

channel

protected String channel

invocationType

@Deprecated
protected InvocationType invocationType

Deprecated.

files

protected List<ClarityFile> files

Since:

2.26

name

protected String name

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.

getScript

public String getScript()

setScript

public void setScript(String script)

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.

getChannel

public String getChannel()

setChannel

public void setChannel(String 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.

getName

public String getName()

setName

public void setName(String 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