com.sas.drugdev.remote.sas
Interface SASService


public interface SASService

The SASService provides a way to publish and examine an SDD process. The intention for this service is to provide a programmatic way to take sas code and associated parameter information and transform it to an SDD process and save it to SDD. Users you can also get current SDD information about a process including modified date and parameter information.


Method Summary
 java.util.List getProcessParameters(File file)
          Gets the parameters as defined in the current SDD process.
 RemoteFile publishProcess(FileBean processFile, java.util.List parameters)
          Takes the SAS code contents on the FileBean and the associated list of parameters and saves it to SDD as a process.
 

Method Detail

publishProcess

public RemoteFile publishProcess(FileBean processFile,
                                 java.util.List parameters)
                          throws RemoteException,
                                 InvalidSessionException,
                                 PermissionException,
                                 InvalidProcessException,
                                 InvalidParameterException,
                                 InvalidNodeBeanException,
                                 ValidationException,
                                 InvalidTypeException,
                                 ContainmentException
Takes the SAS code contents on the FileBean and the associated list of parameters and saves it to SDD as a process. It is saved to the path specified in the FileBean. It assumes the SAS code is process-ready which means it already contains macro variables for which will become parameters in the SDD process. The name for each ProcessParameter should match the macro name as it is used in the SAS code. If there is a ProcessParameter with a name and there is not a macro of that name in the SAS code, it will still generate the parameter in the SDD process as it is define by the ProcessParameter class. If a macro appears in the SAS code, and there is no associated ProcessParameter with that name, it will genreate an ignored parameter in the SDD process and will return a ProcessIgnoredParameter when getProcessParameters(File) is called.

Parameters:
processFile - FileBean containing the SDD path and process-ready SAS code to create the SDD process
parameters - List of ProcessParameter classes that contain parameter information describing the parameters in the process-ready SAS code.
Returns:
The RemoteFile representing the SDD process that was published to SDD
Throws:
RemoteException - if a server or transport error occurs
InvalidSessionException - if the current session is expired or has been invalidated
PermissionException - if the user doesn't have necessary permissions
InvalidProcessException - if FileBean is not of type process
InvalidParameterException - if parameter does not have a valid name, path or other valid information to properly create the parameter in an SDD process
InvalidNodeBeanException - FileBean doesn't have enough information to create the File or an NodeId or version is specified in the FileBean, or if java.io.File set as the contents doesn't exist
ValidationException - if the properties specified don't validate
InvalidTypeException - if the type passed in doesn't exist or is a container type
ContainmentException - if the type can't live here

getProcessParameters

public java.util.List getProcessParameters(File file)
                                    throws RemoteException,
                                           InvalidSessionException,
                                           PermissionException,
                                           InvalidNodeException,
                                           InvalidProcessException
Gets the parameters as defined in the current SDD process. Contents of the process file can be retrieved using RepositoryService.getContents(File, OutputStream). For any parameter types that do not have a directly associated ProcessParameter class will return a ProcessUnknownParameter class.

Parameters:
file - representing the SDD process
Returns:
List of parameters defined to the SDD process
Throws:
RemoteException - if a server or transport error occurs
InvalidSessionException - if the current session is expired or has been invalidated
PermissionException - if the user doesn't have necessary permissions
InvalidNodeException
InvalidProcessException