com.ibm.icm.edc.plugin.api

Class PluginException

  1. java.lang.Object
  2. extended byjava.lang.Throwable
  3. extended byjava.lang.Exception
  4. extended bycom.ibm.icm.edc.workmgr.work.ExportException
  5. extended bycom.ibm.icm.edc.plugin.api.PluginException
All implemented interfaces:
java.io.Serializable
  1. public class PluginException
  2. extends com.ibm.icm.edc.workmgr.work.ExportException
User-defined export plug-ins can use this class to report to the export framework any errors or exceptions that occur during plug-in processing.
See Also:
Serialized Form

Constructor Summary

Constructor and Description
PluginException(java.lang.String pluginClass,java.lang.String id,int errorCode)
Internal use only Creates a plug-in exception
PluginException(java.lang.String pluginClass,java.lang.String id,int errorCode,java.util.List<java.lang.String> errorParams)
Internal use only Creates a plug-in exception, and specifies parameters to be used in the error message
PluginException(java.lang.String pluginClass,java.lang.String id,java.lang.String errorMessage)
Creates a plug-in exception
PluginException(java.lang.String pluginClass,java.lang.String id,java.lang.String propertyFile,java.lang.String errorKey)
Creates a plug-in exception
PluginException(java.lang.String pluginClass,java.lang.String id,java.lang.String propertyFile,java.lang.String errorKey,java.util.List<java.lang.String> errorParams)
Creates a plug-in exception

Method Summary

Modifier and Type Method and Description
  1. int
 getBatchNumber()
  1. int
 getErrorCode()
  1. java.lang.String
 getErrorKey()
  1. java.lang.String
 getErrorMessage()
  1. java.util.List<java.lang.String>
 getErrorParams()
  1. java.lang.String
 getID()
  1. java.lang.String
 getPluginClass()
  1. java.lang.String
 getPropertyFile()
Methods inherited from class com.ibm.icm.edc.workmgr.work.ExportException
getErrorClass, getErrorId, getParms, getSerialVersionUID
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PluginException

  1. public PluginException(java.lang.String pluginClass,
  2. java.lang.String id,
  3. int errorCode)
Internal use only Creates a plug-in exception
Parameters:
pluginClass - the name of the plug-in class that throws the exception
id - the unique identifier of the document or batch that causes the exception
errorCode - an internally-known error code

PluginException

  1. public PluginException(java.lang.String pluginClass,
  2. java.lang.String id,
  3. int errorCode,
  4. java.util.List<java.lang.String> errorParams)
Internal use only Creates a plug-in exception, and specifies parameters to be used in the error message
Parameters:
pluginClass - the name of the plug-in class that throws the exception
id - the unique identifier of the document or batch that causes the exception
errorCode - an internally-known error code
errorParams - the parameters needed for the error message

PluginException

  1. public PluginException(java.lang.String pluginClass,
  2. java.lang.String id,
  3. java.lang.String errorMessage)
Creates a plug-in exception
Parameters:
pluginClass - the name of the plug-in class that throws the exception
id - the unique identifier of the document or batch that causes the exception
errorMessage - the error message to display on the error details panel for the task. This error message is not translated. If the error message must be translated use other constructors that specify a property file.

PluginException

  1. public PluginException(java.lang.String pluginClass,
  2. java.lang.String id,
  3. java.lang.String propertyFile,
  4. java.lang.String errorKey)
Creates a plug-in exception
Parameters:
pluginClass - the name of the plug-in class that throws the exception
id - the unique identifier of the document or batch that causes the exception
propertyFile - the name of the java .properties file that contains the errorKey and message combinations. Store a message in a properties file if the message must be translated.

PluginException

  1. public PluginException(java.lang.String pluginClass,
  2. java.lang.String id,
  3. java.lang.String propertyFile,
  4. java.lang.String errorKey,
  5. java.util.List<java.lang.String> errorParams)
Creates a plug-in exception
Parameters:
pluginClass - the name of the plug-in class that throws the exception
id - the unique identifier of the document or batch that causes the exception

Method Detail

getBatchNumber

  1. public int getBatchNumber()

getErrorCode

  1. public int getErrorCode()

getErrorKey

  1. public java.lang.String getErrorKey( )

getErrorMessage

  1. public java.lang.String getErrorMessage( )

getErrorParams

  1. public java.util.List<java.lang.String> getErrorParams( )

getID

  1. public java.lang.String getID()

getPluginClass

  1. public java.lang.String getPluginClass( )

getPropertyFile

  1. public java.lang.String getPropertyFile( )