Mercurial > dive4elements > river
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/main/java/org/dive4elements/river/client/shared/model/OutputMode.java Thu Apr 25 12:31:32 2013 +0200 @@ -0,0 +1,105 @@ +package de.intevation.flys.client.shared.model; + +import java.io.Serializable; +import java.util.List; + +import de.intevation.flys.client.client.ui.CollectionView; +import de.intevation.flys.client.client.ui.OutputTab; + + +/** + * This interface describes an output mode of an artifact. + * + * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> + */ +public interface OutputMode extends Serializable { + + /** + * Retrieves the name of this mode. + * + * @return the name of this mode. + */ + String getName(); + + + /** + * Retrieves the description of this mode. + * + * @return the description of this mode. + */ + String getDescription(); + + + /** + * Retrieves the mime-type of this mode. + * + * + * @return the mime-type of this mode. + */ + String getMimeType(); + + + /** + * Returns the type of this mode. + * + * @return the type of this mode. + */ + String getType(); + + + /** + * Adds a new facet to this mode. + * + * @param facet The new facet. + */ + void addFacet(Facet facet); + + + /** + * Returns the number of facets supported by this mode. + * + * @return the number of facets. + */ + int getFacetCount(); + + + /** + * Returns the facet at a given position. + * + * @param idx The position of a facet. + * + * @return a facet. + */ + Facet getFacet(int idx); + + + /** + * Returns a facet based on its name. + * + * @param name The name of the facet. + * + * @return a facet or null if no such facet is available. + */ + Facet getFacet(String name); + + + /** + * Returns all facets of this mode. + * + * @return all facets. + */ + List<Facet> getFacets(); + + + /** + * Returns an OutputTab that is used to render the output mode. + * + * @param t The title. + * @param c The Collection. + * @param p The parent CollectionView. + * + * @return an OutputTab. + */ + OutputTab createOutputTab(String t, Collection c, CollectionView p); +} +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :