/*
 * Created on Jan 29, 2005
 *
 * Advanced Data Management Group
 * Center for Advanced Computing and Informatics Studies
 * University of Puerto Rico, Mayaguez
 * 
 */
package ece.uprm.admg.cs2.util;

/**
 * Interface Searchable exposes the methods that must be supported by those
 * objects that can be searched on container class based on the value of a 
 * key. This key is a value that uniquely identifies an object instance. 
 * If two objects have the same key, then they represent the same value.
 * This is an easy to search for large objects. Rather than comparing all 
 * the contents of the objects, the keys are compared. It is assumed that the 
 * application logic enforces the equality of objects based on the equality of 
 * key.
 * 
 * @author Manuel Rodriguez
 *
 */
public interface Searchable {
    
    /**
     * Returns an object that represents the key of the object whose getKey() was 
     * called.
     * @return - the key of the object.
     */
    public Object getKey();

}
