QuoteService.java

/*******************************************************************************
 *  Copyright (c) 2010 Weltevree Beheer BV, Remain Software & Industrial-TSI
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  which accompanies this distribution, and is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  Contributors:
 *     Wim Jongman - initial API and implementation
 *
 *
 *******************************************************************************/
package org.eclipse.ecf.services.quotes;

/**
 * This class creates quotes.
 * 
 * @author Wim Jongman
 * 
 */
public interface QuoteService {

	/**
	 * A short and descriptive name of the service. This could be for instance
	 * "Star Wars" or "20th Century Politics".
	 * 
	 * @return
	 */
	public String getServiceName();

	/**
	 * An extended description of the service.
	 * 
	 * @return
	 */
	public String getServiceDescription();

	/**
	 * Returns a random quote. It is advised to use the following convention
	 * when passing a quote:
	 * <p>
	 * "quote\n\tsignature"
	 * </p>
	 * This will then be displayed as follows:
	 * 
	 * <pre>
	 * When 900 years old, you reach� Look as good, you will not.
	 * 	Yoda to Luke Skywalker, Episode VI: Return Of The Jedi
	 * </pre>
	 * 
	 * @return a quote
	 */
	public String getRandomQuote();

	/**
	 * Returns all quotes.
	 * 
	 * @return
	 */
	public String[] getAllQuotes();

}