From f4875b27929e9d17b311ba3ff53c878f76239147 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Raphael=20M=C3=BC=C3=9Feler?= Date: Fri, 15 Dec 2017 10:43:57 +0100 Subject: [PATCH] bug3484 added and modified JavaDocs in services --- .../sailing/gwt/ui/client/SailingService.java | 2 +- .../gwt/ui/client/SailingServiceAsync.java | 38 ++++++++++++++++++- .../gwt/ui/server/SailingServiceImpl.java | 4 +- .../sailing/server/RacingEventService.java | 13 +++++-- 4 files changed, 49 insertions(+), 8 deletions(-) diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/SailingService.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/SailingService.java index 9c64af9d7fa..684a84524ac 100755 --- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/SailingService.java +++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/SailingService.java @@ -706,6 +706,6 @@ public interface SailingService extends RemoteService, FileStorageManagementGwtS PairingListDTO getPairingListFromRaceLogs(final String leaderboardName) throws NotFoundException; - void fillRaceLogsFromPairingListTemplate(PairingListTemplateDTO pairingListTemplateDTO, final String leaderboardName) + void fillRaceLogsFromPairingListTemplate(final String leaderboardName, final int flightMultiplier) throws NotFoundException, CompetitorRegistrationOnRaceLogDisabledException; } diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/SailingServiceAsync.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/SailingServiceAsync.java index 0cfc3601392..4eadfc4361b 100755 --- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/SailingServiceAsync.java +++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/SailingServiceAsync.java @@ -103,6 +103,7 @@ import com.sap.sse.gwt.client.filestorage.FileStorageManagementGwtServiceAsync; import com.sap.sse.gwt.client.media.ImageDTO; import com.sap.sse.gwt.client.media.VideoDTO; import com.sap.sse.gwt.client.replication.RemoteReplicationServiceAsync; +import com.sap.sse.pairinglist.PairingListTemplate; /** * The async counterpart of {@link SailingService} @@ -874,15 +875,48 @@ public interface SailingServiceAsync extends ServerInfoRetriever, FileStorageMan void addOrReplaceExpeditionDeviceConfiguration(ExpeditionDeviceConfiguration expeditionDeviceConfiguration, AsyncCallback asyncCallback); + /** + * Calculates a {@link PairingListTemplate} based on a competitor count, flight count and group count of the + * leaderboard. Since the competitor count must not be the competitors that are registered on the leaderboard, it can + * vary. + * + * @param leaderboardName the name of the leaderboard + * @param competitorCount the count of competitors + * @param flightMultiplier specifies how often the flights will be cloned + * @param callback returns a {@link PairingListTemplateDTO} + * @throws NotFoundException is thrown if the leaderboard is not found by name + * @throws IllegalArgumentException + */ void calculatePairingList(final String leaderboardName, int competitorCount, int flightMultiplier, - AsyncCallback callback) throws NotFoundException,IllegalArgumentException ; + AsyncCallback callback) throws NotFoundException, IllegalArgumentException; + /** + * Creates a {@link PairingListDTO} in which the competitors will be matched to a {@link PairingList} based on + * the information that the {@link PairingListTemplate} contains. + * + * @param leaderboardName + * @param flightMultiplier specifies how often the flights will be cloned + * @param callback + */ void getPairingListFromTemplate(final String leaderboardName, final int flightMultiplier, AsyncCallback callback); + /** + * Creates a {@link PairingListDTO} that is based on the competitors in the race logs of a leaderboard. + * + * @param leaderboardName the name of the leaderboard + * @param callback returns a {@link PairingListDTO} + */ void getPairingListFromRaceLogs(final String leaderboardName, AsyncCallback callback); - void fillRaceLogsFromPairingListTemplate(PairingListTemplateDTO pairingListTemplateDTO, final String leaderboardName, + /** + * Registers all competitors of a {@link PairingList} in the respective {@link RaceColumn}s and {@link Fleet}s. + * + * @param leaderboardName the name of the leaderboard + * @param flightMultiplier specifies how often the flights will be cloned + * @param callback + */ + void fillRaceLogsFromPairingListTemplate(final String leaderboardName, final int flightMultiplier, AsyncCallback callback); } diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/server/SailingServiceImpl.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/server/SailingServiceImpl.java index be70dcdade0..42152311f84 100755 --- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/server/SailingServiceImpl.java +++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/server/SailingServiceImpl.java @@ -6914,8 +6914,8 @@ public class SailingServiceImpl extends ProxiedRemoteServiceServlet implements S } @Override - public void fillRaceLogsFromPairingListTemplate(PairingListTemplateDTO pairingListTemplateDTO, - final String leaderboardName) throws NotFoundException, CompetitorRegistrationOnRaceLogDisabledException { + public void fillRaceLogsFromPairingListTemplate(final String leaderboardName, final int flightMultiplier) + throws NotFoundException, CompetitorRegistrationOnRaceLogDisabledException { Leaderboard leaderboard = getLeaderboardByName(leaderboardName); diff --git a/java/com.sap.sailing.server/src/com/sap/sailing/server/RacingEventService.java b/java/com.sap.sailing.server/src/com/sap/sailing/server/RacingEventService.java index fa745eca87b..5c1033a89c3 100755 --- a/java/com.sap.sailing.server/src/com/sap/sailing/server/RacingEventService.java +++ b/java/com.sap.sailing.server/src/com/sap/sailing/server/RacingEventService.java @@ -820,13 +820,20 @@ public interface RacingEventService extends TrackedRegattaRegistry, RegattaFetch /** * Returns a calculated {@link PairingListTemplate}, specified by flights, groups and competitors. * - * @param regattaIdentifier {@link RegattaIdentifier} that specifies the flights and groups - * @param competitorsCount count of competitor that is given by a dialog - * @param flightMultiplier + * @param leaderboardName the name of the leaderboard + * @param competitorsCount count of competitor + * @param flightMultiplier specifies how often the flights will be cloned * @return calculated {@link PairingListTemplate} */ PairingListTemplate createPairingListFromRegatta(final String leaderboardName, final int competitorsCount, final int flightMultiplier); + /** + * Matches the competitors of a leaderboard to the {@link PairingList} + * + * @param pairingListTemplate the returned {@link PairingList} is based upon it + * @param leaderboardName name of the leaderboard + * @return {@link PairingList} that contains competitor objects matched to {@link RaceColumn}s and {@link Fleet}s + */ PairingList getPairingListFromTemplate(PairingListTemplate pairingListTemplate, final String leaderboardName); }