Mercurial > dive4elements > river
comparison flys-client/src/main/java/org/dive4elements/river/client/shared/model/OutputMode.java @ 5834:f507086aa94b
Repaired internal references.
author | Sascha L. Teichmann <teichmann@intevation.de> |
---|---|
date | Thu, 25 Apr 2013 12:31:32 +0200 |
parents | flys-client/src/main/java/de/intevation/flys/client/shared/model/OutputMode.java@cd8603aaa730 |
children | 821a02bbfb4e |
comparison
equal
deleted
inserted
replaced
5833:a2bdc0f524e8 | 5834:f507086aa94b |
---|---|
1 package de.intevation.flys.client.shared.model; | |
2 | |
3 import java.io.Serializable; | |
4 import java.util.List; | |
5 | |
6 import de.intevation.flys.client.client.ui.CollectionView; | |
7 import de.intevation.flys.client.client.ui.OutputTab; | |
8 | |
9 | |
10 /** | |
11 * This interface describes an output mode of an artifact. | |
12 * | |
13 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> | |
14 */ | |
15 public interface OutputMode extends Serializable { | |
16 | |
17 /** | |
18 * Retrieves the name of this mode. | |
19 * | |
20 * @return the name of this mode. | |
21 */ | |
22 String getName(); | |
23 | |
24 | |
25 /** | |
26 * Retrieves the description of this mode. | |
27 * | |
28 * @return the description of this mode. | |
29 */ | |
30 String getDescription(); | |
31 | |
32 | |
33 /** | |
34 * Retrieves the mime-type of this mode. | |
35 * | |
36 * | |
37 * @return the mime-type of this mode. | |
38 */ | |
39 String getMimeType(); | |
40 | |
41 | |
42 /** | |
43 * Returns the type of this mode. | |
44 * | |
45 * @return the type of this mode. | |
46 */ | |
47 String getType(); | |
48 | |
49 | |
50 /** | |
51 * Adds a new facet to this mode. | |
52 * | |
53 * @param facet The new facet. | |
54 */ | |
55 void addFacet(Facet facet); | |
56 | |
57 | |
58 /** | |
59 * Returns the number of facets supported by this mode. | |
60 * | |
61 * @return the number of facets. | |
62 */ | |
63 int getFacetCount(); | |
64 | |
65 | |
66 /** | |
67 * Returns the facet at a given position. | |
68 * | |
69 * @param idx The position of a facet. | |
70 * | |
71 * @return a facet. | |
72 */ | |
73 Facet getFacet(int idx); | |
74 | |
75 | |
76 /** | |
77 * Returns a facet based on its name. | |
78 * | |
79 * @param name The name of the facet. | |
80 * | |
81 * @return a facet or null if no such facet is available. | |
82 */ | |
83 Facet getFacet(String name); | |
84 | |
85 | |
86 /** | |
87 * Returns all facets of this mode. | |
88 * | |
89 * @return all facets. | |
90 */ | |
91 List<Facet> getFacets(); | |
92 | |
93 | |
94 /** | |
95 * Returns an OutputTab that is used to render the output mode. | |
96 * | |
97 * @param t The title. | |
98 * @param c The Collection. | |
99 * @param p The parent CollectionView. | |
100 * | |
101 * @return an OutputTab. | |
102 */ | |
103 OutputTab createOutputTab(String t, Collection c, CollectionView p); | |
104 } | |
105 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |