Result.java

/*******************************************************************************
 * Copyright (c) 2010 Philipp Kursawe.
 * 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:
 *   Philipp Kursawe (phil.kursawe@gmail.com) - initial API and implementation
 ******************************************************************************/
package copyto.core;

import org.eclipse.core.runtime.IStatus;

/**
 * Result of a copyTo action.
 * 
 * @author <a href="mailto:kursawe@topsystem.de">Philipp Kursawe</a>
 * @since 1.0
 */
public interface Result {

	/**
	 * @return the Results this Result belongs to.
	 */
	Results getParent();

	/**
	 * @return the copyable that is the result for.
	 */
	Copyable getCopyable();

	/**
	 * @return the location URL where the result was stored. Can be
	 *         <code>null</code> if the copyable could not be stored. Check
	 *         {@link #getStatus()} for a description of the error.
	 */
	// URL getLocation();

	/**
	 * @return time when the result was created.
	 */
	long getTimeStamp();

	/**
	 * @return the status of this result. It can contain additional informations
	 *         about the errors that prevented the copyable to be stored at a
	 *         remote location.
	 */
	IStatus getStatus();
}