001package votorola.s.gwt.stage; // Copyright 2012, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.
002
003import votorola.a.diff.*;
004
005
006/** A page that includes a Crossforum Theatre stage.
007  */
008public interface TheatrePage
009{
010
011
012   // - T h e a t r e - P a g e ----------------------------------------------------------
013
014
015    /** The username of the actor who is shown, or null if nobody in particular is shown
016      * and no default is set.
017      *
018      *     @see votorola.a.voter.IDPair#username()
019      */
020    public String getActorName();
021
022        /** The username of the default actor, or null if there is none.
023          *
024          *     @see #getActorName()
025          */
026        public String getDefaultActorName();
027
028
029
030    /** The key of the difference that is shown, or null if none in particular is shown
031      * and no default is set.
032      */
033    public DiffLook getDifference();
034
035        /** The key of the default difference, or null if there is none.
036          *
037          *     @see #getDifference()
038          */
039        public DiffLook getDefaultDifference();
040
041
042
043    /** The message that is shown, or null if none in particular is shown.
044      */
045    public Message getMessage();
046
047
048
049    /** The name of the poll that is shown, or null if none in particular is shown and no
050      * default is set.
051      *
052      *     @see <a href='http://reluk.ca/w/Category:Poll'
053      *                        target='_top'>Category:Poll</a>
054      */
055    public String getPollName();
056
057        /** The default poll name, or null if there is none.
058          *
059          *     @see #getPollName()
060          */
061        public String getDefaultPollName();
062
063
064
065    /** The URL of the page without a fragment.
066      */
067    public String pageLocation();
068
069
070}