Interface IExplorerImportManager
public interface IExplorerImportManager
Interface for contributing import managers within WebSphere MQ Explorer
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringCommon copyright noticestatic final intReturn code to indicate that an error occured whilst reading the input sourcestatic final intReturn code to indicate that the file extension of the input source is not supportedstatic final intReturn code to indicate that the input source is not valid with the import managerstatic final intReturn code to indicate that the input source is validstatic final intReturn code to indicate that the specified path doesn't existstatic final intReturn code to indicate that the specified path is actually a directorystatic final StringCMVC descriptors - expanded during extraction -
Method Summary
Modifier and TypeMethodDescriptionbooleancanImportId(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.intcheckValidInputSource(com.ibm.mq.commonservices.internal.trace.Trace t) Indicates whether the provided input source is compatible with the Import Manager.booleanimportAll(com.ibm.mq.commonservices.internal.trace.Trace t) Import all applicable categories/subcategories from the supplied input source.booleanimportSubcategories(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.intsetImportSource(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
-
COPYRIGHT_NOTICE
Common copyright notice- See Also:
-
SCCSID
CMVC descriptors - expanded during extraction- See Also:
-
RC_ERROR_WHILE_READING
static final int RC_ERROR_WHILE_READINGReturn code to indicate that an error occured whilst reading the input source- See Also:
-
RC_OK
static final int RC_OKReturn code to indicate that the input source is valid- See Also:
-
RC_PATH_DOESNT_EXIST
static final int RC_PATH_DOESNT_EXISTReturn code to indicate that the specified path doesn't exist- See Also:
-
RC_PATH_IS_DIRECTORY
static final int RC_PATH_IS_DIRECTORYReturn 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_SUPPORTEDReturn 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_VALIDReturn 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:
trueif the import was successful,falseotherwise
-
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 usesubcategories- List of subcategories to import from the source- Returns:
trueif the import was successful,falseotherwise
-
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 usepath-- 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 usecategoryId- Id of the category to checksubcategoryId- Id of the subcategory to check- Returns:
trueif the category and subcateogry combination can be imported by the import manager
-