com.sas.drugdev.remote.sas
Class ProcessFolderParameter

java.lang.Object
  extended bycom.sas.drugdev.remote.sas.ProcessParameter
      extended bycom.sas.drugdev.remote.sas.ProcessPathParameter
          extended bycom.sas.drugdev.remote.sas.ProcessFolderParameter
All Implemented Interfaces:
java.io.Serializable

public class ProcessFolderParameter
extends ProcessPathParameter

Class used to represent a Folder 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
ProcessFolderParameter()
          Constructs a ProcessFolderParameter of FOLDER type
ProcessFolderParameter(java.lang.String name, java.lang.String label, java.lang.String path, boolean allFiles, java.util.Set fileSet, boolean read, boolean write, boolean isRelative)
          Constructs a ProcessFolderParameter from the given data.
 
Method Summary
 java.util.Set getFiles()
          Gets the set of files contained in the folder
 void setFiles(java.util.Set fileSet)
          Sets the files in a folder
 void setUseAllFiles(boolean allFiles)
          Flags to use all files in the folder
 boolean useAllFiles()
          Checks whether to use all files in the folder, or only those specified in the getFiles
 
Methods inherited from class com.sas.drugdev.remote.sas.ProcessPathParameter
getPath, isRead, isRelative, isWrite, setIsRelative, setPath, setRead, setWrite
 
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

ProcessFolderParameter

public ProcessFolderParameter()
Constructs a ProcessFolderParameter of FOLDER type


ProcessFolderParameter

public ProcessFolderParameter(java.lang.String name,
                              java.lang.String label,
                              java.lang.String path,
                              boolean allFiles,
                              java.util.Set fileSet,
                              boolean read,
                              boolean write,
                              boolean isRelative)
Constructs a ProcessFolderParameter from the given data. Note if allFiles is passed as false, a non-empty fileSet must be passed. Otherwise, an InvalidParameterException will be thrown on publish. If allFiles is passed as true, when ProcessIgnoredParameter is called after it is published, the fileSet will be null.

If read and write are both passed as false, the parameter will be defined as a Temporary Folder in the published SDD process. If a path was passed with this parameter, it will ignored. If ProcessIgnoredParameter is called on the published process, path will be returned as null.

Parameters:
name - of the parameter
label - of the parameter. If null is passed, the label will be set to the parameter type.
path - of the folder
allFiles - true if all objects in the folder are files, false otherwise
fileSet - set of files to be referenced when using this folder 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

useAllFiles

public boolean useAllFiles()
Checks whether to use all files in the folder, or only those specified in the getFiles

Returns:
true if to use all files, false otherwise

setUseAllFiles

public void setUseAllFiles(boolean allFiles)
Flags to use all files in the folder

Parameters:
allFiles - true use all files in the folder, false otherwise

getFiles

public java.util.Set getFiles()
Gets the set of files contained in the folder

Returns:
set of the files in the folder

setFiles

public void setFiles(java.util.Set fileSet)
Sets the files in a folder

Parameters:
fileSet - Set of files to set to