Mercurial > dive4elements > river

annotate gwt-client/src/main/java/org/dive4elements/river/client/shared/model/Artifact.java @ 9801:1d7a72a50183 3.2.x tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Assume Compose V2, consistently
author Tom Gottfried <tom@intevation.de>
date Thu, 23 Nov 2023 10:14:13 +0100
parents ea9eef426962
children 611a523fc42f
rev   line source
5861
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
2 * Software engineering by Intevation GmbH
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
3 *
5993
ea9eef426962 Removed trailing whitespace.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5861
diff changeset
4 * This file is Free Software under the GNU AGPL (>=v3)
5861
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
5993
ea9eef426962 Removed trailing whitespace.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5861
diff changeset
6 * documentation coming with Dive4Elements River for details.
5861
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
7 */
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
8
5835
821a02bbfb4e Fixed internal java dependencies
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5834
diff changeset
9 package org.dive4elements.river.client.shared.model;
8
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
10
10
fc616c192902 Modified the Artifact interface and added a DefaultArtifact implementation.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 8
diff changeset
11 import java.io.Serializable;
870
d5fb88ba99d2 Display status message and progress information in the WSPLGEN loading panel.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 862
diff changeset
12 import java.util.List;
10
fc616c192902 Modified the Artifact interface and added a DefaultArtifact implementation.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 8
diff changeset
13
8
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
14
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
15 /**
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
16 * This class represents an artifact for the client. It contains the necessary
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
17 * information for the client and the communication with the artifact server.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
18 *
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
19 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
20 */
10
fc616c192902 Modified the Artifact interface and added a DefaultArtifact implementation.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 8
diff changeset
21 public interface Artifact extends Serializable {
8
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
22
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
23 /**
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
24 * Returns the UUID of the artifact.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
25 *
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
26 * @return the UUID.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
27 */
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
28 public String getUuid();
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
29
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
30
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
31 /**
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
32 * Returns the hash of the artifact.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
33 *
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
34 * @return the hash.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
35 */
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
36 public String getHash();
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
37
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
38
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
39 /**
227
7f7f6d2c4b2c We can now distinuish between different artifact types based on its name in the DESCRIBE. The ArtifactCreator returns concrete instances of Artifacts now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 10
diff changeset
40 * Returns the name of the artifact.
3381
6b5920c7ea6e Cosmetics, docs.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 870
diff changeset
41 * This happens to be the factory name, too.
227
7f7f6d2c4b2c We can now distinuish between different artifact types based on its name in the DESCRIBE. The ArtifactCreator returns concrete instances of Artifacts now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 10
diff changeset
42 *
3381
6b5920c7ea6e Cosmetics, docs.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 870
diff changeset
43 * @return the name.
227
7f7f6d2c4b2c We can now distinuish between different artifact types based on its name in the DESCRIBE. The ArtifactCreator returns concrete instances of Artifacts now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 10
diff changeset
44 */
7f7f6d2c4b2c We can now distinuish between different artifact types based on its name in the DESCRIBE. The ArtifactCreator returns concrete instances of Artifacts now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 10
diff changeset
45 public String getName();
7f7f6d2c4b2c We can now distinuish between different artifact types based on its name in the DESCRIBE. The ArtifactCreator returns concrete instances of Artifacts now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 10
diff changeset
46
7f7f6d2c4b2c We can now distinuish between different artifact types based on its name in the DESCRIBE. The ArtifactCreator returns concrete instances of Artifacts now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 10
diff changeset
47 /**
8
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
48 * Returns the ArtifactDescription.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
49 *
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
50 * @return the artifact description.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
51 */
10
fc616c192902 Modified the Artifact interface and added a DefaultArtifact implementation.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 8
diff changeset
52 public ArtifactDescription getArtifactDescription();
8
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
53
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
54
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
55 /**
862
c9549074ecd1 Parse Artifact's 'background-processing' attribute and lock the UI if this attribute is true.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 227
diff changeset
56 * Returns true, if the Artifact is in Background mode.
c9549074ecd1 Parse Artifact's 'background-processing' attribute and lock the UI if this attribute is true.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 227
diff changeset
57 *
c9549074ecd1 Parse Artifact's 'background-processing' attribute and lock the UI if this attribute is true.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 227
diff changeset
58 * @return true, if the artifact is in background mode.
c9549074ecd1 Parse Artifact's 'background-processing' attribute and lock the UI if this attribute is true.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 227
diff changeset
59 */
c9549074ecd1 Parse Artifact's 'background-processing' attribute and lock the UI if this attribute is true.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 227
diff changeset
60 public boolean isInBackground();
c9549074ecd1 Parse Artifact's 'background-processing' attribute and lock the UI if this attribute is true.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 227
diff changeset
61
c9549074ecd1 Parse Artifact's 'background-processing' attribute and lock the UI if this attribute is true.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 227
diff changeset
62
c9549074ecd1 Parse Artifact's 'background-processing' attribute and lock the UI if this attribute is true.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 227
diff changeset
63 /**
870
d5fb88ba99d2 Display status message and progress information in the WSPLGEN loading panel.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 862
diff changeset
64 * Return a list of background messages.
d5fb88ba99d2 Display status message and progress information in the WSPLGEN loading panel.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 862
diff changeset
65 *
d5fb88ba99d2 Display status message and progress information in the WSPLGEN loading panel.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 862
diff changeset
66 * @return a list of background messages.
d5fb88ba99d2 Display status message and progress information in the WSPLGEN loading panel.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 862
diff changeset
67 */
d5fb88ba99d2 Display status message and progress information in the WSPLGEN loading panel.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 862
diff changeset
68 public List<CalculationMessage> getBackgroundMessages();
d5fb88ba99d2 Display status message and progress information in the WSPLGEN loading panel.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 862
diff changeset
69
d5fb88ba99d2 Display status message and progress information in the WSPLGEN loading panel.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 862
diff changeset
70
d5fb88ba99d2 Display status message and progress information in the WSPLGEN loading panel.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 862
diff changeset
71 /**
8
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
72 * Sets a new ArtifactDescription.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
73 *
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
74 * @param artifactDescription The new artifact description.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
75 */
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
76 public void setArtifactDescription(ArtifactDescription artifactDescription);
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
77 }
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
78 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
http://dive4elements.wald.intevation.org