com.sas.drugdev.remote.sas
Class ProcessPathParameter

java.lang.Object
  extended by com.sas.drugdev.remote.sas.ProcessParameter
      extended by com.sas.drugdev.remote.sas.ProcessPathParameter
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ProcessFileParameter, ProcessFolderParameter

public abstract class ProcessPathParameter
extends ProcessParameter

Abstract class used to represent a path parameter in an SDD process

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.sas.drugdev.remote.sas.ProcessParameter
SDD_PARAMETER_VALUE_TYPE_BASEPATH, SDD_PARAMETER_VALUE_TYPE_BOOLEAN, SDD_PARAMETER_VALUE_TYPE_FOLDER, SDD_PARAMETER_VALUE_TYPE_GROUPVAR, SDD_PARAMETER_VALUE_TYPE_GROUPVARPOS, SDD_PARAMETER_VALUE_TYPE_IGNORE, SDD_PARAMETER_VALUE_TYPE_INCATALOG, SDD_PARAMETER_VALUE_TYPE_INFILE, SDD_PARAMETER_VALUE_TYPE_INPROCESS, SDD_PARAMETER_VALUE_TYPE_INTABLE, SDD_PARAMETER_VALUE_TYPE_LISTFILE, SDD_PARAMETER_VALUE_TYPE_LISTMAP, SDD_PARAMETER_VALUE_TYPE_LOGFILE, SDD_PARAMETER_VALUE_TYPE_NSELECTED, SDD_PARAMETER_VALUE_TYPE_NUMERIC, SDD_PARAMETER_VALUE_TYPE_OUTCATALOG, SDD_PARAMETER_VALUE_TYPE_OUTFILE, SDD_PARAMETER_VALUE_TYPE_OUTTABLE, SDD_PARAMETER_VALUE_TYPE_PARMFILE, SDD_PARAMETER_VALUE_TYPE_PGMFILE, SDD_PARAMETER_VALUE_TYPE_SELECTIONLIST, SDD_PARAMETER_VALUE_TYPE_TEMPFOLDER, SDD_PARAMETER_VALUE_TYPE_TEXT, SDD_PARAMETER_VALUE_TYPE_VALUELIST, SDD_PARAMETER_VALUE_TYPE_VARIABLE, SDD_PARAMETER_VALUE_TYPE_VARLIST
 
Constructor Summary
ProcessPathParameter()
          Constructs a ProcessPathParameter object of FOLDER type
ProcessPathParameter(java.lang.String name, java.lang.String label, java.lang.String path, boolean read, boolean write, boolean isRelative)
          Constructs a ProcessPathParameter with the given data
 
Method Summary
 java.lang.String getPath()
          Gets the destination path of the parameter
 boolean isRead()
          Checks if the parameter is readable
 boolean isRelative()
          Checks if the parameter is a relative path
 boolean isWrite()
          Checks if the parameter is writable
 void setIsRelative(boolean isRelative)
          Sets the parameter to be relative or absolute.
 void setPath(java.lang.String path)
          Sets the destination path of the parameter
 void setRead(boolean read)
          Sets the parameter as readable
 void setWrite(boolean write)
          Sets the parameter as writable
 
Methods inherited from class com.sas.drugdev.remote.sas.ProcessParameter
getAttributes, getLabel, getName, getType, isEnabled, isRequired, setAttributes, setEnabled, setLabel, setName, setRequired, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProcessPathParameter

public ProcessPathParameter()
Constructs a ProcessPathParameter object of FOLDER type


ProcessPathParameter

public ProcessPathParameter(java.lang.String name,
                            java.lang.String label,
                            java.lang.String path,
                            boolean read,
                            boolean write,
                            boolean isRelative)
Constructs a ProcessPathParameter with the given data

Parameters:
name - of the parameter
path - of the parameter
read - true if readable, false otherwise
write - true if writable, false otherwise
isRelative - true if the path is relative, false if absolute
Method Detail

getPath

public java.lang.String getPath()
Gets the destination path of the parameter

Returns:
the destination path

setPath

public void setPath(java.lang.String path)
Sets the destination path of the parameter

Parameters:
path - to set

isRead

public boolean isRead()
Checks if the parameter is readable

Returns:
true if readable, false otherwise

setRead

public void setRead(boolean read)
Sets the parameter as readable

Parameters:
read - true to make readable, false otherwise

isWrite

public boolean isWrite()
Checks if the parameter is writable

Returns:
true if writable, false otherwise

setWrite

public void setWrite(boolean write)
Sets the parameter as writable

Parameters:
write - true to make writable, false otherwise

isRelative

public boolean isRelative()
Checks if the parameter is a relative path

Returns:
true if relative, false if absolute

setIsRelative

public void setIsRelative(boolean isRelative)
Sets the parameter to be relative or absolute. Default is false. If set to true, it is assumed the path is already set relative to the location of the published process.

Parameters:
isRelative - true to make relative, false to make absolute