package votorola.a.trust; // Copyright 2008, 2010-2011, 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.voter.*;
import votorola.g.lang.*;


/** A node representing a single registrant in a network trace.
  */
public interface TraceNode extends java.io.Serializable // serializeable for votorola.a.web.wic.VSession
{


   // - T r a c e - N o d e --------------------------------------------------------------


    /** The registrant's local area of residence, or null if unspecified.  This is used
      * only for multi-area streetwikis.
      *
      *     @see <a href='http://reluk.ca/w/Property:Area'
      *                                     >Property:Area</a>
      */
    public String getArea();



    /** The registrant's country of residence in <a
      * href='http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'>ISO_3166-1 alpha-2</a>
      * form, or null if unspecified.
      *
      *     @see <a href='http://reluk.ca/w/Property:Country_code'
      *                                     >Property:Country_code</a>
      */
    public String getCountryCode();



    /** The normalized, geo-locatable address string for the registrant's primary
      * residential address.
      *
      *     @return geohandle, or null if unknown.
      *
      *     @see <a href='http://reluk.ca/w/Property:Geohandle'
      *                                     >Property:Geohandle</a>
      */
    public String getGeohandle();



    /** Other registration properties. These are formatted as an XML element named
      * 'other', which may have any content.  The content is set by intermediation of the
      * local administrator's <code>votrace.js</code> script.
      *
      *     @return XML element named 'other'; or null, if there are no other properties
      *
      *     @see <a href='http://reluk.ca/project/votorola/s/_/example/full/home/vdev/votorola/trust/votrace.js'
      *      >Working example of <code>votrace.js</code></a>
      */
    public String getOtherProperties(); // untested on the reference server



    /** The number of primary trust edges extending to this node.
      */
    public int primaryTrustEdgeCount();



    /** The registrant.
      */
    public IDPair registrant();



    /** Calculates the trust level of this node.  The trust level is the highest level (T)
      * among all immediate trust sources, such that the count of sources at that level or
      * higher (nT) is at least equal to T (nT >= T).  For example, to have a trust level
      * of 3, this node must have 3 or more immediate trust sources, each itself at level
      * 3 or higher.
      */
    public int trustLevel();



}