From 5ae6e4deb1f880ded6a1cb804aa449932dae9033 Mon Sep 17 00:00:00 2001
From: Nils Christian Ehmke <nie@informatik.uni-kiel.de>
Date: Sat, 13 Apr 2013 10:45:06 +0200
Subject: [PATCH] Added some comments
---
.../kieker/webgui/persistence/IProjectDAO.java | 14 ++++++++++++--
.../kieker/webgui/service/IProjectService.java | 14 ++++++++++++--
2 files changed, 24 insertions(+), 4 deletions(-)
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/persistence/IProjectDAO.java b/Kieker.WebGUI/src/main/java/kieker/webgui/persistence/IProjectDAO.java
index d65ce62f..97f634a5 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/persistence/IProjectDAO.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/persistence/IProjectDAO.java
@@ -153,7 +153,9 @@ public interface IProjectDAO {
* @param username
* The name of the user who saves the project.
* @param analysisLayout
- * The current layout of the analysis graph. It is valid if this parameter is null.
+ * The current layout of the analysis graph. It is valid if this parameter is null. In this case the stored layout will not be changed.
+ * @param cockpitLayout
+ * The current layout of the cockpit. It is valid if this parameter is null. In this case the stored layout will not be changed.
*
* @throws ProjectNotExistingException
* If a project with the given name does not exist.
@@ -286,7 +288,7 @@ public interface IProjectDAO {
public abstract String getLastUser(final String projectName);
/**
- * Delivers the stored layout for the given project.
+ * Delivers the stored analysis layout for the given project.
*
* @param projectName
* The name of the project.
@@ -296,6 +298,14 @@ public interface IProjectDAO {
@PreAuthorize("isAuthenticated()")
public abstract String getAnalysisLayout(String projectName);
+ /**
+ * Delivers the stored cockpit layout for the given project.
+ *
+ * @param projectName
+ * The name of the project.
+ *
+ * @return The layout string as it is stored within the meta data. If this isn't available, null will be returned.
+ */
@PreAuthorize("isAuthenticated()")
public abstract String getCockpitLayout(String projectName);
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/service/IProjectService.java b/Kieker.WebGUI/src/main/java/kieker/webgui/service/IProjectService.java
index 2927a8e3..f36a4281 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/service/IProjectService.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/service/IProjectService.java
@@ -163,7 +163,9 @@ public interface IProjectService {
* @param username
* The name of the user who saves the project.
* @param analysisLayout
- * The current layout of the analysis graph. It is valid if this parameter is null.
+ * The current layout of the analysis graph. It is valid if this parameter is null. In this case the stored layout will not be changed.
+ * @param cockpitLayout
+ * The current layout of the cockpit. It is valid if this parameter is null. In this case the stored layout will not be changed.
*
* @throws ProjectNotExistingException
* If a project with the given name does not exist.
@@ -388,7 +390,7 @@ public interface IProjectService {
public boolean deleteLibrary(String projectName, String libName) throws IOException;
/**
- * Delivers the stored layout for the given project.
+ * Delivers the stored analysis layout for the given project.
*
* @param projectName
* The name of the project.
@@ -398,6 +400,14 @@ public interface IProjectService {
@PreAuthorize("isAuthenticated()")
public abstract String getAnalysisLayout(String projectName);
+ /**
+ * Delivers the stored cockpit layout for the given project.
+ *
+ * @param projectName
+ * The name of the project.
+ *
+ * @return The layout string as it is stored within the meta data. If this isn't available, null will be returned.
+ */
@PreAuthorize("isAuthenticated()")
public abstract String getCockpitLayout(String projectName);
}
--
GitLab