package 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.

import votorola.a.position.*;


/** A pollwiki in an Outcast voting network.
  *
  *     @see <a href='http://reluk.ca/project/_/outcast/dep.xht#wiki' target='_top'
  *                                   >project/outcast/dep.xht#wiki</a>
  */
public interface Pollwiki
{


   // - P o l l w i k i ------------------------------------------------------------------


    /** Appends an already encoded page name to the wiki base URL.  Usage example:<pre>
      *
      *     String href = pollwiki.appendPageSpecifier( "Main_page" ).toString();</pre>
      */
    public StringBuilder appendPageSpecifier( String encodedPageName );



    /** Answers whether the wiki URL might be based on the standard access URL ending in
      * "index.php" for example, or is definitely based on a pretty alias per
      * <code>$wgUsePathInfo</code>.
      *
      *     @see <a href='http://www.mediawiki.org/wiki/Manual:$wgUsePathInfo'
      *                                          target='_top'>$wgUsePathInfo</a>
      */// per INLDOC
    public boolean maybeUgly();



    /** A recognizer of pipes in the pollwiki.
      */
    public PipeRecognizer pipeRecognizer();



    /** Returns the page name of the specified position.
      *
      *     @param pollName this parameter is ignored if the named person is actually a
      *       pipe.
      *
      *     @see PositionID#pageName(String,String,PipeRecognizer)
      *     @see <a href='http://reluk.ca/w/Category:Position'
      *                        target='_top'>Category:Position</a>
      */
    public String positionPageName( final String personName, final String pollName );


}