Interface IExternalObjectRestorer


  • public interface IExternalObjectRestorer
    External object restorer allows to restore external object dumps to existing objects.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void restore​(String projectName, Version version, org.eclipse.core.resources.IProject baseProject, Path path, org.eclipse.core.runtime.IProgressMonitor monitor)
      Create external object project with the provided name and version if it does not exist and restore provided external object dump.
      void restore​(org.eclipse.core.resources.IProject project, Path sourcePath, Path targetPath, org.eclipse.core.runtime.IProgressMonitor monitor)
      Restore provided external object dump to provided target folder in specifed project context.
      void restore​(org.eclipse.core.resources.IProject project, Path path, org.eclipse.core.runtime.IProgressMonitor monitor)
      Restore provided external object dump in the given external object project.
    • Method Detail

      • restore

        void restore​(org.eclipse.core.resources.IProject project,
                     Path path,
                     org.eclipse.core.runtime.IProgressMonitor monitor)
              throws org.eclipse.core.runtime.CoreException
        Restore provided external object dump in the given external object project. Dump path must be an existing file with external object dump. Usually, dumps have *.epf or *.erf file extensions.

        Restore operation may be long-running. Progress and cancellation are provided by the given progress monitor.

        Parameters:
        project - the external object project, that holds object, cannot be null
        path - the source path of external object dump, cannot be null
        monitor - the progress monitor for reporting progress on how the wait is progressing, or null if no progress monitoring is required
        Throws:
        org.eclipse.core.runtime.CoreException - if dump fails
      • restore

        void restore​(String projectName,
                     Version version,
                     org.eclipse.core.resources.IProject baseProject,
                     Path path,
                     org.eclipse.core.runtime.IProgressMonitor monitor)
              throws org.eclipse.core.runtime.CoreException
        Create external object project with the provided name and version if it does not exist and restore provided external object dump. Dump path must be an existing file with external object dump. Usually, dumps have *.epf or *.erf file extensions.

        Restore operation may be long-running. Progress and cancellation are provided by the given progress monitor.

        Parameters:
        projectName - the external object project name, cannot be null
        version - the project version, cannot be null
        baseProject - the base project for the external object project, cannot be null
        path - the source path of external object dump, cannot be null
        monitor - the progress monitor for reporting progress on how the wait is progressing, or null if no progress monitoring is required
        Throws:
        org.eclipse.core.runtime.CoreException - if dump fails
      • restore

        void restore​(org.eclipse.core.resources.IProject project,
                     Path sourcePath,
                     Path targetPath,
                     org.eclipse.core.runtime.IProgressMonitor monitor)
              throws org.eclipse.core.runtime.CoreException
        Restore provided external object dump to provided target folder in specifed project context. Dump path must be an existing file with external object dump. Usually, dumps have *.epf or *.erf file extensions.

        Restore operation may be long-running. Progress and cancellation are provided by the given progress monitor.

        Parameters:
        project - the external object project name, cannot be null
        sourcePath - the source path of external object dump, cannot be null
        targetPath - the target path to put restored root XML fiile of external object dump to, cannot be null
        monitor - the progress monitor for reporting progress on how the wait is progressing, or null if no progress monitoring is required
        Throws:
        org.eclipse.core.runtime.CoreException - if dump fails