tools/remotetools/org.eclipse.ptp.remotetools.core/src/org/eclipse/ptp/remotetools/core/IRemoteItem.java

/******************************************************************************
 * Copyright (c) 2006 IBM Corporation.
 * 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:
 *     IBM Corporation - Initial Implementation
 *
 *****************************************************************************/
package org.eclipse.ptp.remotetools.core;

import org.eclipse.ptp.remotetools.exception.CancelException;
import org.eclipse.ptp.remotetools.exception.RemoteConnectionException;
import org.eclipse.ptp.remotetools.exception.RemoteExecutionException;
import org.eclipse.ptp.remotetools.exception.RemoteOperationException;

/**
 * @author richardm
 *
 */
public interface IRemoteItem {

	public String getPath();
	public boolean exists();
	
	/**
	 * Returns true if the remote item has a permission that allows to read this
	 * item. Several permissions are considered (user, group, others) to
	 * calculate de effective permission.
	 * 
	 * @return true/false
	 */
	public boolean isReadable();
	public void setReadable(boolean flag);
	
	/**
	 * Returns true if the remote item has a permission that allows to write
	 * this item. Several permissions are considered (user, group, others) to
	 * calculate de effective permission.
	 * 
	 * @return false
	 */
	public boolean isWritable();
	public void setWriteable(boolean flag);
	
//	public long getCreationTime();
//	public void setCreationTime(long time);

	public long getModificationTime();
	public void setModificationTime(long time);

	public long getAccessTime();
//	public void setAccessTime(long time);

//	public String getUserId();
//	public String setUserId();
//	
//	public String getGroupId();
//	public String setGroupId();
	
	/**
	 * Fetch all the attributes from the item on remote host.
	 * @throws RemoteOperationException 
	 */
	public void refreshAttributes() throws RemoteConnectionException, RemoteOperationException, CancelException;
	
	/**
	 * Apply all the attributes to the item on remote host.
	 * For efficiency, only changed attributes may be written.
	 */
	public void commitAttributes() throws RemoteConnectionException, RemoteOperationException, CancelException;
	
}