com.konakartadmin.blif

Interface Xml_io_If

public interface Xml_io_If

Interface to an Importer/Exporter

Method Summary

Modifier and Type	Method and Description
int	do_io(java.lang.String sessionId, KKAdminIf eng, java.lang.String emptyDBFile, java.lang.String bootstrapFile, int direction, java.lang.String xmlFileRoot, java.lang.String kkPropsFile, java.lang.String storeId, XmlIoDataConfig dc, boolean debug)
int	do_io(java.lang.String emptyDBFile, java.lang.String bootstrapFile, int direction, java.lang.String xmlFileRoot, java.lang.String kkPropsFile, java.lang.String userName, java.lang.String password, boolean useSOAP, java.lang.String webServiceUrl, java.lang.String storeId, int engineMode, boolean customersShared, boolean productsShared, boolean categoriesShared, XmlIoDataConfig dc, boolean debug)

Method Detail

do_io

int do_io(java.lang.String emptyDBFile,
          java.lang.String bootstrapFile,
          int direction,
          java.lang.String xmlFileRoot,
          java.lang.String kkPropsFile,
          java.lang.String userName,
          java.lang.String password,
          boolean useSOAP,
          java.lang.String webServiceUrl,
          java.lang.String storeId,
          int engineMode,
          boolean customersShared,
          boolean productsShared,
          boolean categoriesShared,
          XmlIoDataConfig dc,
          boolean debug)
   throws java.lang.Exception

Parameters:

emptyDBFile - the name of a file containing SQL commands to empty the target database for the specified store, prior to data loading (executed before the bootstrapFile script below).

bootstrapFile - the name of a file containing SQL commands to load into the target database for the specified store, prior to data loading (executed after the emptyDBFile script above).

direction - Xml_io.IMPORT (1) for IMPORT and Xml_io.EXPORT (2) for export

xmlFileRoot - the root directory for the data

kkPropsFile - name of the konakartadmin.properties file to use

userName - Admin Engine username

password - Admin Engine password

useSOAP - set to true to use SOAP to access the KOnaKart Admin Engine

webServiceUrl - if using SOAP this must contain the KonaKart Admin App's web services endpoint URL.

storeId - (the storeId - will be the source or target storeId depending on whether this is an import or an export).

engineMode - KonaKart engine mode (0, 1 or 2)

customersShared - set to true for shared customers

productsShared - set to true for shared products

categoriesShared - set to true for shared categories

dc - DataConfig definition for XML I/O. It defines which tables are exported/imported

debug - set to true to enable debug

Returns:

0 for success otherwise a positive integer indicating a failure.

Throws:

java.lang.Exception - an unexpected exception

do_io

int do_io(java.lang.String sessionId,
          KKAdminIf eng,
          java.lang.String emptyDBFile,
          java.lang.String bootstrapFile,
          int direction,
          java.lang.String xmlFileRoot,
          java.lang.String kkPropsFile,
          java.lang.String storeId,
          XmlIoDataConfig dc,
          boolean debug)
   throws java.lang.Exception

Parameters:

sessionId - The sessionId of the valid current session on the specified admin engine

eng - An admin engine to use for the import/export

emptyDBFile - the name of a file containing SQL commands to empty the target database for the specified store, prior to data loading (executed before the bootstrapFile script below).

bootstrapFile - the name of a file containing SQL commands to load into the target database for the specified store, prior to data loading (executed after the emptyDBFile script above).

direction - Xml_io.IMPORT (1) for IMPORT and Xml_io.EXPORT (2) for export

xmlFileRoot - the root directory for the data

kkPropsFile - name of the konakartadmin.properties file to use

storeId - (the storeId - will be the source or target storeId depending on whether this is an import or an export).

dc - DataConfig definition for XML I/O. It defines which tables are exported/imported

debug - set to true to enable debug

Returns:

0 for success otherwise a positive integer indicating a failure.

Throws:

java.lang.Exception - an unexpected exception