Interface IExplorerImportManager


public interface IExplorerImportManager
Interface for contributing import managers within WebSphere MQ Explorer
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Common copyright notice
    static final int
    Return code to indicate that an error occured whilst reading the input source
    static final int
    Return code to indicate that the file extension of the input source is not supported
    static final int
    Return code to indicate that the input source is not valid with the import manager
    static final int
    Return code to indicate that the input source is valid
    static final int
    Return code to indicate that the specified path doesn't exist
    static final int
    Return code to indicate that the specified path is actually a directory
    static final String
    CMVC descriptors - expanded during extraction
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canImportId(com.ibm.mq.commonservices.internal.trace.Trace t, String categoryId, String subcategoryId)
    Inquires if the Import Manager is able to import the supplied category - subcategory combination.
    int
    checkValidInputSource(com.ibm.mq.commonservices.internal.trace.Trace t)
    Indicates whether the provided input source is compatible with the Import Manager.
    boolean
    importAll(com.ibm.mq.commonservices.internal.trace.Trace t)
    Import all applicable categories/subcategories from the supplied input source.
    boolean
    importSubcategories(com.ibm.mq.commonservices.internal.trace.Trace t, List<com.ibm.mq.explorer.ui.internal.importexport.ImportExportSubcategory> subcategories)
    Import the specified categories/subcategories (if applicable) from the supplied input source.
    int
    setImportSource(com.ibm.mq.commonservices.internal.trace.Trace t, org.eclipse.core.runtime.IPath path)
    Sets the path of the file to be used as a source of the import.
  • Field Details

    • SCCSID

      static final String SCCSID
      CMVC descriptors - expanded during extraction
      See Also:
    • RC_ERROR_WHILE_READING

      static final int RC_ERROR_WHILE_READING
      Return code to indicate that an error occured whilst reading the input source
      See Also:
    • RC_OK

      static final int RC_OK
      Return code to indicate that the input source is valid
      See Also:
    • RC_PATH_DOESNT_EXIST

      static final int RC_PATH_DOESNT_EXIST
      Return code to indicate that the specified path doesn't exist
      See Also:
    • RC_PATH_IS_DIRECTORY

      static final int RC_PATH_IS_DIRECTORY
      Return code to indicate that the specified path is actually a directory
      See Also:
    • RC_FILE_EXTENSION_NOT_SUPPORTED

      static final int RC_FILE_EXTENSION_NOT_SUPPORTED
      Return code to indicate that the file extension of the input source is not supported
      See Also:
    • RC_FILE_NOT_VALID

      static final int RC_FILE_NOT_VALID
      Return code to indicate that the input source is not valid with the import manager
      See Also:
  • Method Details

    • importAll

      boolean importAll(com.ibm.mq.commonservices.internal.trace.Trace t)
      Import all applicable categories/subcategories from the supplied input source.
      Parameters:
      t - the trace context to use
      Returns:
      true if the import was successful, false otherwise
    • importSubcategories

      boolean importSubcategories(com.ibm.mq.commonservices.internal.trace.Trace t, List<com.ibm.mq.explorer.ui.internal.importexport.ImportExportSubcategory> subcategories)
      Import the specified categories/subcategories (if applicable) from the supplied input source.
      Parameters:
      t - the trace context to use
      subcategories - List of subcategories to import from the source
      Returns:
      true if the import was successful, false otherwise
    • setImportSource

      int setImportSource(com.ibm.mq.commonservices.internal.trace.Trace t, org.eclipse.core.runtime.IPath path)
      Sets the path of the file to be used as a source of the import. It is up to the implementing Import Manager to appropriately extract relevant information from this source.
      Parameters:
      t - the trace context to use
      path -
      Returns:
      int representing the status of the input source. Must be one of the static RC's defined in this interface.
    • checkValidInputSource

      int checkValidInputSource(com.ibm.mq.commonservices.internal.trace.Trace t)
      Indicates whether the provided input source is compatible with the Import Manager.
      Parameters:
      t - the trace context to use
      Returns:
      int representing the status of the input source. Must be one of the static RC's defined in this interface.
    • canImportId

      boolean canImportId(com.ibm.mq.commonservices.internal.trace.Trace t, String categoryId, String subcategoryId)
      Inquires if the Import Manager is able to import the supplied category - subcategory combination.
      Parameters:
      t - the trace context to use
      categoryId - Id of the category to check
      subcategoryId - Id of the subcategory to check
      Returns:
      true if the category and subcateogry combination can be imported by the import manager