From ea9cce017d1ee2e4390c6dd61ada4d397e53491c Mon Sep 17 00:00:00 2001
From: Benjamin Barth <benjamin.barth@sap.com>
Date: Thu, 23 Jun 2016 15:12:33 +0200
Subject: [PATCH] Added JavaDoc to GetRegattaListViewAction class

---
 .../event/GetRegattaListViewAction.java       | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/communication/event/GetRegattaListViewAction.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/communication/event/GetRegattaListViewAction.java
index 988f09cf788..5b2ab095212 100644
--- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/communication/event/GetRegattaListViewAction.java
+++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/communication/event/GetRegattaListViewAction.java
@@ -9,13 +9,24 @@ import com.sap.sailing.gwt.home.communication.SailingAction;
 import com.sap.sailing.gwt.home.communication.SailingDispatchContext;
 import com.sap.sailing.gwt.home.communication.regatta.RegattaWithProgressDTO;
 import com.sap.sailing.gwt.home.server.EventActionUtil;
-import com.sap.sailing.gwt.home.server.LeaderboardContext;
 import com.sap.sailing.gwt.home.server.EventActionUtil.LeaderboardCallback;
+import com.sap.sailing.gwt.home.server.LeaderboardContext;
 import com.sap.sse.common.Duration;
 import com.sap.sse.gwt.dispatch.shared.caching.IsClientCacheable;
 import com.sap.sse.gwt.dispatch.shared.commands.ResultWithTTL;
 import com.sap.sse.gwt.dispatch.shared.commands.SortedSetResult;
 
+/**
+ * <p>
+ * {@link SailingAction} implementation to load data to be shown on the event overview or regattas page for the
+ * {@link #GetRegattaListViewAction(UUID) given event-id}, preparing the appropriate data structure.
+ * </p>
+ * <p>
+ * The {@link ResultWithTTL result's} time to live
+ * {@link EventActionUtil#getEventStateDependentTTL(SailingDispatchContext, UUID, Duration) depends on the event's
+ * state} using a duration of <i>3 minutes</i> for currently running events.
+ * </p>
+ */
 public class GetRegattaListViewAction implements SailingAction<ResultWithTTL<SortedSetResult<RegattaWithProgressDTO>>>,
         IsClientCacheable {
     private UUID eventId;
@@ -24,6 +35,12 @@ public class GetRegattaListViewAction implements SailingAction<ResultWithTTL<Sor
     private GetRegattaListViewAction() {
     }
 
+    /**
+     * Creates a {@link GetRegattaListViewAction} instance for the given event-id.
+     * 
+     * @param eventId
+     *            {@link UUID} of the event to load regattas for
+     */
     public GetRegattaListViewAction(UUID eventId) {
         this.eventId = eventId;
     }