IRemoteFileSystemBrowseEvent.java

/****************************************************************************
 * Copyright (c) 2007, 2009 Composent, Inc., IBM and others.
 * 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:
 *    Composent, Inc. - initial API and implementation
 *    Henrich Kraemer - bug 263613, [transport] Update site contacting / downloading is not cancelable
 *****************************************************************************/

package org.eclipse.ecf.filetransfer.events;

import org.eclipse.ecf.filetransfer.IRemoteFile;

/**
 * Event that indicates that a directory list is available via {@link #getRemoteFiles()}.
 * <p>
 * This event is fired even if the browse failed or has been canceled. In this case
 * the cause is provided via {@link #getException()}.
 * </p> 
 */
public interface IRemoteFileSystemBrowseEvent extends IRemoteFileSystemEvent {

	/**
	 * Get the list of files associated with this browse event.  If the original
	 * file ID available via {@link IRemoteFileSystemEvent#getFileID()} is a regular
	 * file, the array will be of length 1.  If a directory, will be of length n.
	 * Is null if the associated IRemoteFileSystemRequest failed or was canceled.
	 * The cause will be available in {@link #getException()}. 
	 * @return IRemoteFile[] the array of remote files for the given browse.  If the original
	 * file ID available via {@link IRemoteFileSystemEvent#getFileID()} is a regular
	 * file, the array will be of length 1.  If a directory, will be of length n.
	 * May be null. 
	 */
	public IRemoteFile[] getRemoteFiles();

}