EGF Engine
Release 0.1.0

org.eclipse.egf.common.helper
Interface IUserEnforcedHelper

All Known Implementing Classes:
UserEnforcedHelper

public interface IUserEnforcedHelper

User enforced helper.
Handles user interactions when automatic ones are no longer sufficient.
Allows the user to be warned about specific changes (sometimes through a user confirmation request).


Method Summary
 IStatus makeFileWritable(IFile file_p)
          Make given file writable.
 IStatus makeFileWritable(IFile file_p, Object display_p)
          Make given file writable.
 

Method Detail

makeFileWritable

IStatus makeFileWritable(IFile file_p)
Make given file writable.
Such an implementation deals with the UI issues spawn by the act of asking the user (if needed).
That includes executing the enforcement in the UI thread.

Parameters:
file_p - The file that should be made writable.
Returns:
Status#OK_STATUS if file was made writable or doesn't exist. Status#CANCEL_STATUS otherwise.

makeFileWritable

IStatus makeFileWritable(IFile file_p,
                         Object display_p)
Make given file writable.
The caller is responsible for making sure it is executed in the UI thread.
Otherwise an invalid thread access exception might be thrown by the platform.

Parameters:
file_p - The file that should be made writable.
display_p - Used to ask the user permission, if needed.
Returns:
Status#OK_STATUS if file was made writable or doesn't exist. Status#CANCEL_STATUS otherwise.

EGF Engine
Release 0.1.0

Copyright (c) Thales Corporate Services S.A.S, 2009.

This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.