WorkflowParam (SeqWare 1.1.2 API)

java.lang.Object
- net.sourceforge.seqware.common.security.PermissionsAware
- - net.sourceforge.seqware.common.model.WorkflowParam

All Implemented Interfaces:

Serializable, Cloneable, Comparable<WorkflowParam>
```
public class WorkflowParam
extends PermissionsAware
implements Serializable, Comparable<WorkflowParam>, Cloneable
```
WorkflowParam class.

Version:

$Id: $Id

Author:

boconnor

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkflowParam()
Constructor for WorkflowParam.

Constructors
Constructor and Description
`WorkflowParam()` Constructor for WorkflowParam.

Method Summary

Methods
Modifier and Type	Method and Description
`WorkflowParam`	`clone()`
`int`	`compareTo(WorkflowParam that)`
`boolean`	`equals(Object other)`
`String`	`getDefaultValue()` Getter for the field `defaultValue`.
`Boolean`	`getDisplay()` Getter for the field `display`.
`String`	`getDisplayName()` Getter for the field `displayName`.
`String`	`getDisplayValue()` Getter for the field `displayValue`.
`String`	`getFileMetaType()` Getter for the field `fileMetaType`.
`List<File>`	`getFiles()` Getter for the field `files`.
`String`	`getJsonEscapeDefaultValue()` getJsonEscapeDefaultValue.
`String`	`getJsonEscapeDisplayName()` getJsonEscapeDisplayName.
`String`	`getJsonEscapeKey()` getJsonEscapeKey.
`String`	`getJsonEscapeType()` getJsonEscapeType.
`String`	`getJsonEscapeValue()` getJsonEscapeValue.
`String`	`getKey()` Getter for the field `key`.
`Sample`	`getSample()` Getter for the field `sample`.
`String`	`getType()` Getter for the field `type`.
`String`	`getValue()` Getter for the field `value`.
`SortedSet<WorkflowParamValue>`	`getValues()` Getter for the field `values`.
`Workflow`	`getWorkflow()` Getter for the field `workflow`.
`Integer`	`getWorkflowParamId()` Getter for the field `workflowParamId`.
`boolean`	`givesPermissionInternal(Registration registration, Set<Integer> considered)` Short-circuit permission checking by providing a set of entities that have already been checked
`int`	`hashCode()`
`Boolean`	`isDisplay()` isDisplay.
`void`	`setDefaultValue(String defaultValue)` Setter for the field `defaultValue`.
`void`	`setDisplay(Boolean display)` Setter for the field `display`.
`void`	`setDisplayName(String displayName)` Setter for the field `displayName`.
`void`	`setDisplayValue(String displayValue)` Setter for the field `displayValue`.
`void`	`setFileMetaType(String fileMetaType)` Setter for the field `fileMetaType`.
`void`	`setFiles(List<File> files)` Setter for the field `files`.
`void`	`setKey(String key)` Setter for the field `key`.
`void`	`setSample(Sample sample)` Setter for the field `sample`.
`void`	`setType(String type)` Setter for the field `type`.
`void`	`setValue(String value)` Setter for the field `value`.
`void`	`setValues(SortedSet<WorkflowParamValue> values)` Setter for the field `values`.
`void`	`setWorkflow(Workflow workflow)` Setter for the field `workflow`.
`void`	`setWorkflowParamId(Integer workflowParamId)` Setter for the field `workflowParamId`.
`String`	`toString()`

Methods inherited from class net.sourceforge.seqware.common.security.PermissionsAware
givesPermission, givesPermission

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WorkflowParam
```
public WorkflowParam()
```
    Constructor for WorkflowParam.
- Method Detail
  - compareTo
```
public int compareTo(WorkflowParam that)
```
    Specified by:
    
    compareTo in interface Comparable<WorkflowParam>
    
    Parameters:
    that -
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
    
    Parameters:
    other -
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getWorkflowParamId
```
public Integer getWorkflowParamId()
```
    Getter for the field workflowParamId.
    
    Returns:
    a Integer object.
  - setWorkflowParamId
```
public void setWorkflowParamId(Integer workflowParamId)
```
    Setter for the field workflowParamId.
    
    Parameters:
    workflowParamId - a Integer object.
  - getWorkflow
```
public Workflow getWorkflow()
```
    Getter for the field workflow.
    
    Returns:
    a Workflow object.
  - setWorkflow
```
public void setWorkflow(Workflow workflow)
```
    Setter for the field workflow.
    
    Parameters:
    workflow - a Workflow object.
  - getType
```
public String getType()
```
    Getter for the field type.
    
    Returns:
    a String object.
  - getJsonEscapeType
```
public String getJsonEscapeType()
```
    getJsonEscapeType.
    
    Returns:
    a String object.
  - setType
```
public void setType(String type)
```
    Setter for the field type.
    
    Parameters:
    type - a String object.
  - getKey
```
public String getKey()
```
    Getter for the field key.
    
    Returns:
    a String object.
  - getJsonEscapeKey
```
public String getJsonEscapeKey()
```
    getJsonEscapeKey.
    
    Returns:
    a String object.
  - setKey
```
public void setKey(String key)
```
    Setter for the field key.
    
    Parameters:
    key - a String object.
  - getJsonEscapeDefaultValue
```
public String getJsonEscapeDefaultValue()
```
    getJsonEscapeDefaultValue.
    
    Returns:
    a String object.
  - getDefaultValue
```
public String getDefaultValue()
```
    Getter for the field defaultValue.
    
    Returns:
    a String object.
  - setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
    Setter for the field defaultValue.
    
    Parameters:
    defaultValue - a String object.
  - isDisplay
```
public Boolean isDisplay()
```
    isDisplay.
    
    Returns:
    a Boolean object.
  - getDisplay
```
public Boolean getDisplay()
```
    Getter for the field display.
    
    Returns:
    a Boolean object.
  - setDisplay
```
public void setDisplay(Boolean display)
```
    Setter for the field display.
    
    Parameters:
    display - a Boolean object.
  - getFileMetaType
```
public String getFileMetaType()
```
    Getter for the field fileMetaType.
    
    Returns:
    a String object.
  - setFileMetaType
```
public void setFileMetaType(String fileMetaType)
```
    Setter for the field fileMetaType.
    
    Parameters:
    fileMetaType - a String object.
  - getJsonEscapeDisplayName
```
public String getJsonEscapeDisplayName()
```
    getJsonEscapeDisplayName.
    
    Returns:
    a String object.
  - getDisplayName
```
public String getDisplayName()
```
    Getter for the field displayName.
    
    Returns:
    a String object.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Setter for the field displayName.
    
    Parameters:
    displayName - a String object.
  - getValues
```
public SortedSet<WorkflowParamValue> getValues()
```
    Getter for the field values.
    
    Returns:
    a SortedSet object.
  - setValues
```
public void setValues(SortedSet<WorkflowParamValue> values)
```
    Setter for the field values.
    
    Parameters:
    values - a SortedSet object.
  - getJsonEscapeValue
```
public String getJsonEscapeValue()
```
    getJsonEscapeValue.
    
    Returns:
    a String object.
  - getValue
```
public String getValue()
```
    Getter for the field value.
    
    Returns:
    a String object.
  - setValue
```
public void setValue(String value)
```
    Setter for the field value.
    
    Parameters:
    value - a String object.
  - getDisplayValue
```
public String getDisplayValue()
```
    Getter for the field displayValue.
    
    Returns:
    a String object.
  - setDisplayValue
```
public void setDisplayValue(String displayValue)
```
    Setter for the field displayValue.
    
    Parameters:
    displayValue - a String object.
  - getSample
```
public Sample getSample()
```
    Getter for the field sample.
    
    Returns:
    a Sample object.
  - setSample
```
public void setSample(Sample sample)
```
    Setter for the field sample.
    
    Parameters:
    sample - a Sample object.
  - getFiles
```
public List<File> getFiles()
```
    Getter for the field files.
    
    Returns:
    a List object.
  - setFiles
```
public void setFiles(List<File> files)
```
    Setter for the field files.
    
    Parameters:
    files - a List object.
  - clone
```
public WorkflowParam clone()
                    throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Returns:
    
    Throws:
    
    CloneNotSupportedException
  - givesPermissionInternal
```
public boolean givesPermissionInternal(Registration registration,
                              Set<Integer> considered)
```
    Short-circuit permission checking by providing a set of entities that have already been checked
    
    Specified by:
    
    givesPermissionInternal in class PermissionsAware
    
    Returns:

Class WorkflowParam

Constructor Summary

Method Summary

Methods inherited from class net.sourceforge.seqware.common.security.PermissionsAware

Methods inherited from class java.lang.Object

Constructor Detail

WorkflowParam

Method Detail

compareTo

toString

equals

hashCode

getWorkflowParamId

setWorkflowParamId

getWorkflow

setWorkflow

getType

getJsonEscapeType

setType

getKey

getJsonEscapeKey

setKey

getJsonEscapeDefaultValue

getDefaultValue

setDefaultValue

isDisplay

getDisplay

setDisplay

getFileMetaType

setFileMetaType

getJsonEscapeDisplayName

getDisplayName

setDisplayName

getValues

setValues

getJsonEscapeValue

getValue

setValue

getDisplayValue

setDisplayValue

getSample

setSample

getFiles

setFiles

clone

givesPermissionInternal