org.eclipse.rse.persistence
Interface IRSEPersistenceProvider

public interface IRSEPersistenceProvider

This is the interface that needs to be implemented when providing an extension using the RSE persistence provider extension point. Implement this class to provide a specialized means of saving and restoring RSEDOM

Method Summary

IStatus	deleteProfile(String profileName, IProgressMonitor monitor) Removes a profile.
String[]	getSavedProfileNames()
RSEDOM	loadRSEDOM(String profileName, IProgressMonitor monitor) Restores an RSE DOM given a profileName.
boolean	saveRSEDOM(RSEDOM dom, IProgressMonitor monitor) Persists an RSE DOM.

Method Detail

loadRSEDOM

public RSEDOM loadRSEDOM(String profileName,
                         IProgressMonitor monitor)

Restores an RSE DOM given a profileName.

Parameters:

profileName - name of the Profile to load

monitor -

Returns:

the RSE DOM for the specified profile

saveRSEDOM

public boolean saveRSEDOM(RSEDOM dom,
                          IProgressMonitor monitor)

Persists an RSE DOM.

Parameters:

dom - the RSE DOM to persist

monitor -

Returns:

true if succcessful

getSavedProfileNames

public String[] getSavedProfileNames()

Returns:

The names of the profiles that have been saved by this persistence provider.

deleteProfile

public IStatus deleteProfile(String profileName,
                             IProgressMonitor monitor)

Removes a profile. Does nothing if the profile is not found.

Parameters:

profileName - the name of the profile to remove

monitor - the monitor for the operation