Package wt.ixb.publicforapps

Class ApplicationImportHandlerTemplate

java.lang.Object
wt.ixb.publicforapps.ApplicationImportHandlerTemplate
All Implemented Interfaces:
ApplicationExpImportHandler, ApplicationImportHandler
Direct Known Subclasses:
ApplicationImportHandlerForJar, ApplicationImportHandlerForRepository, ApplicationImportHandlerForXml
public class ApplicationImportHandlerTemplate extends Object implements ApplicationImportHandler
/** Class extends ApplicationImportHandler interface with trivial implementations. It can be used by application to make application less dependent of future extension of ApplicationImportHandler interface.

Supported API: true

Extendable: true

  • Method Details

    • isMultithreadedImportApplicable

      public boolean isMultithreadedImportApplicable()
      Get the flag as true or false respectively based on if multi thread Import is applicable or not.

      Supported API: true
      Returns:
      boolean

    • isMultiple

      public boolean isMultiple()
      Gets the value of the attribute: multiple.

      Supported API: true
      Returns:
      multiple
      Throws:
      WTException

    • setMultiple

      public void setMultiple(boolean multiple)
      Sets the value of the attribute: multiple.

      Supported API: true
      Parameters:
      multiple -
      Throws:
      WTException

    • cleanUpAfterImport

      public void cleanUpAfterImport(boolean outcome) throws WTException
      do some cleanup operations after import

      Supported API: true
      Parameters:
      outcome -
      Throws:
      WTException

    • getContentAsInputStream

      public InputStream getContentAsInputStream(String contentId) throws WTException
      Returns InputStream representing input information for import process

      Supported API: true
      Specified by:
      getContentAsInputStream in interface ApplicationImportHandler
      Parameters:
      contentId - The unique id to identify the content data, such as the file name (including the path) in a jar file.
      Returns:
      InputStream
      Throws:
      WTException

    • getContentAsApplicationData

      public ApplicationData getContentAsApplicationData(String contentId) throws WTException
      Returns ApplicationData representing input information for import process. Import application does not have really implement this method. It can simple return null.

      Supported API: true
      Specified by:
      getContentAsApplicationData in interface ApplicationImportHandler
      Parameters:
      contentId - The unique id to identify the content data, such as the file name (including the path) in a jar file.
      Returns:
      ApplicationData
      Throws:
      WTException

    • importObjectNotification

      public void importObjectNotification(Object object, boolean created, IxbElement fileXML) throws WTException
      Notifies application about objects, that are created in import process.

      Supported API: true
      Specified by:
      importObjectNotification in interface ApplicationImportHandler
      Parameters:
      object -
      created - "true" if import process creates new object and "false" otherwise.
      fileXML -
      Throws:
      WTException

    • finalizeImportObjectNotification

      public void finalizeImportObjectNotification(Object object) throws WTException
      Notifies application about objects after being persisted.

      Supported API: true
      Specified by:
      finalizeImportObjectNotification in interface ApplicationImportHandler
      Parameters:
      object -
      Throws:
      WTException

    • storeLogMessage

      public void storeLogMessage(String resourceBundle, String messageKey, Object[] textInserts, int importanceLevel) throws WTException
      Supplies the localized log message for the application.

      Supported API: true
      Specified by:
      storeLogMessage in interface ApplicationExpImportHandler
      Parameters:
      resourceBundle -
      messageKey -
      textInserts -
      importanceLevel -
      Throws:
      WTException

    • storeLogMessage

      public void storeLogMessage(String resourceBundle, String messageKey, Object[] textInserts) throws WTException
      Supplies the localized log message for the application.

      Supported API: true
      Parameters:
      resourceBundle -
      messageKey -
      textInserts -
      Throws:
      WTException

    • getSize

      public long getSize(String jarEntryPath) throws WTException

      get the size of jarEntryPath
      Supported API: true
      Parameters:
      jarEntryPath -
      Returns:
      size
      Throws:
      WTException

    • isIxbWithGUI

      public boolean isIxbWithGUI()

      get the value of attribute ixbWithGUI
      Supported API: true
      Returns:
      ixbWithGUI

    • setIxbWithGUI

      public void setIxbWithGUI(boolean ixbWithGUI)

      set the value of attribute ixbWithGUI
      Supported API: true
      Parameters:
      ixbWithGUI -

    • getUserLogLevel

      public int getUserLogLevel()

      get the value of attribute userLogLevel
      Supported API: true
      Returns:
      userLogLevel

    • setUserLogLevel

      public void setUserLogLevel(int userLogLevel)

      set the value of attribute userLogLevel
      Supported API: true
      Parameters:
      userLogLevel -

    • getFormatType

      public ExportImportFormatType getFormatType()

      get the value of attribute formatType
      Supported API: true
      Returns:
      formatType

    • setFormatType

      public void setFormatType(ExportImportFormatType formatType)

      set the value of attribute formatType
      Supported API: true
      Parameters:
      formatType -

    • setIXApplicationContext

      public void setIXApplicationContext(IXApplicationContext appContext)
      Sets the value of the IX application context.

      Supported API: true
      Parameters:
      appContext -

    • getIXApplicationContext

      public IXApplicationContext getIXApplicationContext()
      Returns the value of the current IX application context.

      Supported API: true
      Returns: