package votorola.a.diff; // Copyright 2012-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.


/** The parameters for a difference view.
  */
public interface DiffLook
{


   // - D i f f - L o o k ----------------------------------------------------------------


    /** The {@linkplain DiffKey difference key}.
      */
    public String key();



    /** The selectand for the {@linkplain votorola.s.wic.diff.WP_D difference bridge} 's'
      * parameter, specified as difference ordinal "a" or "b".
      *
      *     @see <a href='../../../a/diff/DiffKey.html#ord'>Normal ordering</a>
      */      // per INLDOC
    public String selectand();



    /** Whether to persist this difference along with other staged state.
      *
      *     @see <a href='Stage.html#persistPage'>Persistence of state in a single page</a>
      */      // per INLDOC
    public boolean toPersist();



   // - O b j e c t ----------------------------------------------------------------------


    /** Normally answers whether o is a difference look with the same key and selectand.
      * But do not depend on this behaviour in GWT clients where this look might be a
      * JavaScriptObject; instead use the DiffLookJS {@linkplain DiffLookJS#EQUATOR
      * EQUATOR} which works in all cases.
      */
    public @Override boolean equals( final Object o );


}