public interface AQProject
Modifier and Type | Method and Description |
---|---|
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.
|
AQServerConnection[] getServerConnections()
AQServerConnection[] getServerConnections(String folder, boolean recursive)
folder
- the folderrecursive
- if recursive operationAQServerConnection getServerConnection(String path)
path
- Path to the desired project connection relative to the "Servers" folder.AQProjectFile getServerConnectionsRootFolder()
AQProjectFile getAquaScriptsRootFolder()
AQProjectFile getAquaScript(String path)
path
- Path to the desired file relative to "AquaScripts" folder.AQProjectFile getUserFilesRootFolder()
AQProjectFile getUserFile(String path)
path
- Path to the desired file relative to "User Files" folder.AQProjectFile[] collectUserFiles(String path)
path
- Path to the desired file relative to "User Files" folder.AQProjectFile[] collectUserFiles(String path, String filter)
path
- Path to the desired folder relative to "User Files".filter
- File filter specification string.boolean deleteUserFile(String path)
path
- Path to the desired file relative to "User Files" folder.Properties loadProperties(String fileName)
fileName
- name of the file in the project User Files directoryvoid saveProperties(Properties properties, String fileName)
properties
- Property listfileName
- file name of the file in the project User Files directory.String getDashboardURL()
String getChartURL()
String getRunURL()
Copyright © 2017 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.