1 dojo.provide("calitha.collections.IComparable");
  2 dojo.require("calitha.exception.VirtualFunctionException");
  3 
  4 /**
  5  * @name calitha.collections.IComparable
  6  * @class This interface imposes a total ordering on the objects of each class that implements it.
  7  * <p>
  8  * It is based on the
  9  * <a href="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html">Java Comparable interface</a>.
 10  */
 11 dojo.declare("calitha.collections.IComparable", null,
 12 /** @lends calitha.collections.IComparable#*/
 13 {
 14     /**
 15      * @function
 16      * @param o the object to be compared. 
 17      * @return {Number} a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
 18      * @description Compares this object with the specified object for order.
 19      */
 20     compareTo: function(/**Object*/ o)
 21     {throw new calitha.exception.VirtualFunctionException(Error());}
 22 });
 23