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; +/** + *
+ * {@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. + *
+ *+ * The {@link ResultWithTTL result's} time to live + * {@link EventActionUtil#getEventStateDependentTTL(SailingDispatchContext, UUID, Duration) depends on the event's + * state} using a duration of 3 minutes for currently running events. + *
+ */ public class GetRegattaListViewAction implements SailingAction