com.ibm.etools.systems.pushtoclient.core.extensions

Interface IConfigurationExtension

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void exportToCache(IConfigurationElement element, IFolder cacheFolder, IProgressMonitor monitor)
      Exports the specified configuration to the specified cache folder
      IConfigurationElement getExportElement()
      Gets the parent IConfigurationElement that represents export resources for this configuration
      java.lang.String getIcon()
      Gets the relative path from the defining plugin to the icon associated with this extension
      java.lang.String getId()
      Gets the unique id associated with the extension
      IConfigurationElement getImportElement(java.io.File cacheFolder)
      Gets the parent IConfigurationElement that represents import resources for this configuration
      java.lang.String getName()
      Gets the name associated with the extension
      void importToWorkspace(IConfigurationElement element, IProgressMonitor monitor)
      Imports the specified configuration to the workspace
      void populateExportElements(IConfigurationElement parent)
      Populates the tree of configuration elements that represent this configuration for export
      void populateImportElements(IConfigurationElement parent)
      Populates the tree of configuration elements that represent this configuration for import
      void resetExportElement()
      Clears any existing export elements so that fresh info can be retrieved.
      void resetImportElement()
      Clears any existing import elements so that fresh info can be retrieved.
      void setBundle(Bundle bundle)
      Sets the bundle associated with this extension
      void setIcon(java.lang.String icon)
      Sets the relative path from the defining plugin to the icon associated with this extension
      • Methods inherited from interface java.lang.Comparable

        compareTo
    • Method Detail

      • getName

        java.lang.String getName()
        Gets the name associated with the extension
        Returns:
        the name
      • getId

        java.lang.String getId()
        Gets the unique id associated with the extension
        Returns:
        the id
      • getIcon

        java.lang.String getIcon()
        Gets the relative path from the defining plugin to the icon associated with this extension
        Returns:
        the relative path of the icon
      • setIcon

        void setIcon(java.lang.String icon)
        Sets the relative path from the defining plugin to the icon associated with this extension
        Parameters:
        icon - the icon path
      • setBundle

        void setBundle(Bundle bundle)
        Sets the bundle associated with this extension
        Parameters:
        bundle - the bundle associated with this extension
      • resetExportElement

        void resetExportElement()
        Clears any existing export elements so that fresh info can be retrieved.
      • resetImportElement

        void resetImportElement()
        Clears any existing import elements so that fresh info can be retrieved.
      • getExportElement

        IConfigurationElement getExportElement()
        Gets the parent IConfigurationElement that represents export resources for this configuration
        Returns:
        the parent configuration element for this configuration extension
      • populateExportElements

        void populateExportElements(IConfigurationElement parent)
        Populates the tree of configuration elements that represent this configuration for export
        Parameters:
        parent - the parent configuration element for this extension
      • getImportElement

        IConfigurationElement getImportElement(java.io.File cacheFolder)
        Gets the parent IConfigurationElement that represents import resources for this configuration
        Parameters:
        cacheFolder - the folder containing the cached configuration files used for importing
        Returns:
        the parent configuration element
      • populateImportElements

        void populateImportElements(IConfigurationElement parent)
        Populates the tree of configuration elements that represent this configuration for import
        Parameters:
        parent - the parent configuration element for this extension
      • exportToCache

        void exportToCache(IConfigurationElement element,
                           IFolder cacheFolder,
                           IProgressMonitor monitor)
        Exports the specified configuration to the specified cache folder
        Parameters:
        element - the parent element representing resources to export to cache
        cacheFolder - the folder where resources are to be exported to
        monitor - the progress monitor
      • importToWorkspace

        void importToWorkspace(IConfigurationElement element,
                               IProgressMonitor monitor)
        Imports the specified configuration to the workspace
        Parameters:
        element - the parent configuration element
        monitor - the progress monitor