com.aquafold.openapi.project
Interface AQProject

public interface AQProject

Interface for project-specific functionality available via aqua.project alias.

Method Summary

AQProjectFile[]	collectUserFiles(String path) Recursively scans the specified path in the "User Files" project folder.
AQProjectFile[]	collectUserFiles(String path, String filter) Recursively scans the specified path in the "User Files" project folder.
boolean	deleteUserFile(String path) Deletes a file in the "User File" project folder.
AQProjectFile	getAquaScript(String path) Returns a file object with the specified path under the "AquaScripts" project folder.
AQProjectFile	getAquaScriptsRootFolder() Returns a file object corresponding to the "AquaScripts" folder.
String	getChartURL() Returns the full URL path to the chart entry point on Aqua Data Server.
String	getDashboardURL() Returns the full URL path to the dashboard entry point on Aqua Data Server for the current project.
String	getFileURL(String name) Returns the full URL path to the specified file under "User Files" folder.
String	getRunURL() Returns the full URL path to the run-script entry point on Aqua Data Server.
AQServerConnection	getServerConnection(String path) Returns a project server connection.
AQServerConnection[]	getServerConnections() Returns all server connections available within the script context.
AQServerConnection[]	getServerConnections(String folder, boolean recursive) Returns all server connections in the current folder, and subfolders if recursive flag is passed true.
AQProjectFile	getServerConnectionsRootFolder() Returns a file object corresponding to the "Servers" project folder.
AQProjectFile	getUserFile(String path) Returns a file object within "User Files" project folder.
AQProjectFile	getUserFilesRootFolder() Returns a file object corresponding to the "User Files" project folder.
Properties	loadProperties(String fileName) Reads a propery list from a file in the project User Files directory.
void	saveProperties(Properties properties, String fileName) Saves a property list to a file in the project User Files directory.

Method Detail

getServerConnections

AQServerConnection[] getServerConnections()

Returns all server connections available within the script context.

getServerConnections

AQServerConnection[] getServerConnections(String folder,
                                          boolean recursive)

Returns all server connections in the current folder, and subfolders if recursive flag is passed true.

getServerConnection

AQServerConnection getServerConnection(String path)

Returns a project server connection. Throws an exception if the specified path cannot be found.

Parameters:

path - Path to the desired project connection relative to the "Servers" folder.

getServerConnectionsRootFolder

AQProjectFile getServerConnectionsRootFolder()

Returns a file object corresponding to the "Servers" project folder. Files in this folder and the folder itself are read-only.

getAquaScriptsRootFolder

AQProjectFile getAquaScriptsRootFolder()

Returns a file object corresponding to the "AquaScripts" folder. Files in this folder and the folder itself are read-only.

getAquaScript

AQProjectFile getAquaScript(String path)

Returns a file object with the specified path under the "AquaScripts" project folder. Files in "AquaScripts" folder are read-only.

Parameters:

path - Path to the desired file relative to "AquaScripts" folder.

getUserFilesRootFolder

AQProjectFile getUserFilesRootFolder()

Returns a file object corresponding to the "User Files" project folder.

getUserFile

AQProjectFile getUserFile(String path)

Returns a file object within "User Files" project folder.

Parameters:

path - Path to the desired file relative to "User Files" folder.

collectUserFiles

AQProjectFile[] collectUserFiles(String path)

Recursively scans the specified path in the "User Files" project folder. Returns an array of files.

Parameters:

path - Path to the desired file relative to "User Files" folder.

collectUserFiles

AQProjectFile[] collectUserFiles(String path,
                                 String filter)

Recursively scans the specified path in the "User Files" project folder. Returns an array of files whose name complies with the specified file name filter. The file name filter supports standard wildcard characters * and ?.

Parameters:

path - Path to the desired folder relative to "User Files".

filter - File filter specification string.

deleteUserFile

boolean deleteUserFile(String path)

Deletes a file in the "User File" project folder. Returns true if the file has been successfully deleted.

Parameters:

path - Path to the desired file relative to "User Files" folder.

loadProperties

Properties loadProperties(String fileName)

Reads a propery list from a file in the project User Files directory. The method returns an empty Properties object in the case of a read error or attempting to read a file that does not exists.

Parameters:

fileName - name of the file in the project User Files directory

saveProperties

void saveProperties(Properties properties,
                    String fileName)

Saves a property list to a file in the project User Files directory.

Parameters:

properties - Property list

fileName - file name of the file in the project User Files directory.

getDashboardURL

String getDashboardURL()

Returns the full URL path to the dashboard entry point on Aqua Data Server for the current project.

getChartURL

String getChartURL()

Returns the full URL path to the chart entry point on Aqua Data Server.

getRunURL

String getRunURL()

Returns the full URL path to the run-script entry point on Aqua Data Server.

getFileURL

String getFileURL(String name)

Returns the full URL path to the specified file under "User Files" folder.

Parameters:

name - File path relative to "User Files" project folder.