001package votorola.a; // Copyright 2008-2013, 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.position.*;
004
005
006/** A pollwiki in an Outcast voting network.
007  *
008  *     @see <a href='http://reluk.ca/project/_/outcast/dep.xht#wiki' target='_top'
009  *                                   >project/outcast/dep.xht#wiki</a>
010  */
011public interface Pollwiki
012{
013
014
015   // - P o l l w i k i ------------------------------------------------------------------
016
017
018    /** Appends an already encoded page name to the wiki base URL.  Usage example:<pre>
019      *
020      *     String href = pollwiki.appendPageSpecifier( "Main_page" ).toString();</pre>
021      */
022    public StringBuilder appendPageSpecifier( String encodedPageName );
023
024
025
026    /** Answers whether the wiki URL might be based on the standard access URL ending in
027      * "index.php" for example, or is definitely based on a pretty alias per
028      * <code>$wgUsePathInfo</code>.
029      *
030      *     @see <a href='http://www.mediawiki.org/wiki/Manual:$wgUsePathInfo'
031      *                                          target='_top'>$wgUsePathInfo</a>
032      */// per INLDOC
033    public boolean maybeUgly();
034
035
036
037    /** A recognizer of pipes in the pollwiki.
038      */
039    public PipeRecognizer pipeRecognizer();
040
041
042
043    /** Returns the page name of the specified position.
044      *
045      *     @param pollName this parameter is ignored if the named person is actually a
046      *       pipe.
047      *
048      *     @see PositionID#pageName(String,String,PipeRecognizer)
049      *     @see <a href='http://reluk.ca/w/Category:Position'
050      *                        target='_top'>Category:Position</a>
051      */
052    public String positionPageName( final String personName, final String pollName );
053
054
055}