org.eclipse.rse.ui.view
Interface ISystemEditableRemoteObject

All Known Implementing Classes:

SystemEditableRemoteFile

public interface ISystemEditableRemoteObject

This interface defines some common functionality required from all remote resources for edit, irrespective of whether the remote system is an OS/400, Windows, Linux or Unix operating system.

Field Summary

static int	NOT_OPEN
static int	OPEN_IN_DIFFERENT_PERSPECTIVE
static int	OPEN_IN_SAME_PERSPECTIVE

Method Summary

void	addAsListener() Register as listener for various events
int	checkOpenInEditor() Is the local file open in an editor
boolean	doImmediateSaveAndUpload() Saves the local file and uploads it to the host immediately, rather than, in response to a resource change event.
boolean	download(IProgressMonitor monitor) Download the file.
boolean	download(Shell shell) Download the file.
boolean	exists() Returns whether the edited object exists.
String	getAbsolutePath() Return the absolute path on the remote system.
IEditorPart	getEditorPart() Returns the open IEditorPart for this remote object if there is one.
IFile	getLocalResource() Get the local resource
IAdaptable	getRemoteObject() Returns the remote object that is editable
ISubSystem	getSubSystem() Return the subsystem for the edited object.
boolean	isDirty() Check if the file is dirty
boolean	isReadOnly() Check if user has write authority to the file.
boolean	isStale() Returns whether the underlying resource needs to be updated from the host
void	open(boolean readOnly, IProgressMonitor monitor) Open in editor
void	open(IProgressMonitor monitor) Open in editor
void	open(Shell shell) Open in editor
void	open(Shell shell, boolean readOnly) Open in editor
void	openEditor() Open the editor
void	setEditor(IEditorPart editorPart) Set the editor variable given an exiting editor part
void	setLocalResourceProperties() Set local resource properties
void	setReadOnly(boolean isReadOnly) Indicate whether the file can be edited
void	updateDirtyIndicator() Update the editor dirty indicator

Field Detail

NOT_OPEN

public static final int NOT_OPEN

See Also:

Constant Field Values

OPEN_IN_SAME_PERSPECTIVE

public static final int OPEN_IN_SAME_PERSPECTIVE

See Also:

Constant Field Values

OPEN_IN_DIFFERENT_PERSPECTIVE

public static final int OPEN_IN_DIFFERENT_PERSPECTIVE

See Also:

Constant Field Values

Method Detail

isReadOnly

public boolean isReadOnly()

Check if user has write authority to the file.

Returns:

true if user has write authority to the file, false otherwise

setReadOnly

public void setReadOnly(boolean isReadOnly)

Indicate whether the file can be edited

setEditor

public void setEditor(IEditorPart editorPart)

Set the editor variable given an exiting editor part

Parameters:

editorPart - the editor

download

public boolean download(Shell shell)
                 throws Exception

Download the file.

Parameters:

shell - if the shell is null, no progress monitor will be shown

Returns:

true if successful, false if cancelled

Throws:

Exception

download

public boolean download(IProgressMonitor monitor)
                 throws Exception

Download the file.

Parameters:

monitor - the progress monitor

Returns:

true if the operation was successful. false if the user cancels.

Throws:

Exception

doImmediateSaveAndUpload

public boolean doImmediateSaveAndUpload()

Saves the local file and uploads it to the host immediately, rather than, in response to a resource change event.

Returns:

true if the operation was successful. false if the upload fails.

getLocalResource

public IFile getLocalResource()

Get the local resource

checkOpenInEditor

public int checkOpenInEditor()
                      throws CoreException

Is the local file open in an editor

Throws:

CoreException

getEditorPart

public IEditorPart getEditorPart()

Returns the open IEditorPart for this remote object if there is one.

getRemoteObject

public IAdaptable getRemoteObject()

Returns the remote object that is editable

open

public void open(Shell shell)

Open in editor

open

public void open(Shell shell,
                 boolean readOnly)

Open in editor

open

public void open(IProgressMonitor monitor)

Open in editor

open

public void open(boolean readOnly,
                 IProgressMonitor monitor)

Open in editor

setLocalResourceProperties

public void setLocalResourceProperties()
                                throws Exception

Set local resource properties

Throws:

Exception

addAsListener

public void addAsListener()

Register as listener for various events

openEditor

public void openEditor()
                throws PartInitException

Open the editor

Throws:

PartInitException

updateDirtyIndicator

public void updateDirtyIndicator()

Update the editor dirty indicator

isDirty

public boolean isDirty()

Check if the file is dirty

getAbsolutePath

public String getAbsolutePath()

Return the absolute path on the remote system.

getSubSystem

public ISubSystem getSubSystem()

Return the subsystem for the edited object.

exists

public boolean exists()

Returns whether the edited object exists.

isStale

public boolean isStale()

Returns whether the underlying resource needs to be updated from the host