|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 the RSE DOM. This interface is used by the persistence manager to schedule loads and saves of the DOM and should only be used by the persistence manager.
Method Summary | |
---|---|
IStatus |
deleteProfile(String profileName,
IProgressMonitor monitor)
Removes a profile. |
String[] |
getMigratedProfileNames()
|
String[] |
getSavedProfileNames()
|
Job |
getSaveJob(RSEDOM dom)
Returns a job suitable for saving a DOM. |
RSEDOM |
loadRSEDOM(String profileName,
IProgressMonitor monitor)
Restores an RSE DOM given a profileName. |
boolean |
saveRSEDOM(RSEDOM dom,
IProgressMonitor monitor)
Persists an RSE DOM. |
IStatus |
setMigrationMark(String profileName,
boolean migrated)
Sets the migration state of a profile. |
void |
setProperties(Properties properties)
Sets the properties for this provider. |
boolean |
supportsMigration()
Indicates whether or not this persistence provider supports migration. |
Method Detail |
---|
void setProperties(Properties properties)
properties
- the properties object containing the properties
supplied in the extension.RSEDOM loadRSEDOM(String profileName, IProgressMonitor monitor)
profileName
- name of the Profile to loadmonitor
- The monitor to use for progress monitoring and cancellation.
Must not be null.
boolean saveRSEDOM(RSEDOM dom, IProgressMonitor monitor)
RSEDOMNode.markUpdated()
.
dom
- the RSE DOM to persist.monitor
- The monitor to use for progress monitoring and cancellation.
Must not be null.
Job getSaveJob(RSEDOM dom)
dom
- the DOM for which to construct the job.
String[] getSavedProfileNames()
IStatus deleteProfile(String profileName, IProgressMonitor monitor)
profileName
- the name of the profile to removemonitor
- The monitor to use for progress monitoring and cancellation.
Must not be null.
IStatus setMigrationMark(String profileName, boolean migrated)
profileName
- the name of the profile of which to set the migration statemigrated
- true if the profile is to be marked as migrated, false if it is to be marked as normal.
Normal profiles are returned in getSavedProfileNames()
, migrated profiles are returned
in getMigratedProfileNames()
.
IRSECoreStatusCodes
String[] getMigratedProfileNames()
setMigrationMark(String, boolean)
.
This may be an empty array but will never be null.boolean supportsMigration()
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |