/**
 * <p>
 * Copyright © 2009-2010, Bruce-Robert Pocock
 * </p>
 * <p>
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 * </p>
 * <p>
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * </p>
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * </p>
 * 
 * @author brpocock
 */

package org.starhope.appius.util;

/**
 * This is a convenience interface for things that must have a
 * user-visible name. Complements the toString method for
 * programmer-visible names.
 * 
 * @author brpocock
 */
public interface HasName {
	/**
	 *Return a user-visible, unique name for this class. This name may
	 * not necessarily be globally unique, but must be unique across all
	 * objects of this class. For example, having both a User and a Zone
	 * named “Lightning” is acceptable, but there may not be two users
	 * with the same name.
	 * 
	 * @return a user-visible string name for this instance
	 */
	public String getName ();
}