Process API

filenet.vw.api
Class VWXMLConfiguration

java.lang.Object
  extended by filenet.vw.api.VWXMLConfiguration

public final class VWXMLConfiguration
extends java.lang.Object

VWXMLConfiguration imports and exports XML text representing Process Engine administration and configuration objects that implement the IVWtoXML interface.

Since:
P8 3.0

Field Summary
static java.lang.String ATTRINFO_CONFIG_ALLOW_USER_ENTER_WSDL
           
static int IMPORT_EXCLUDE_USERINFO
          Value of 16. Indicates exclusion of user info; the default is to import user info.
static int IMPORT_MERGE
          Value of 2. Indicates import properties will be added to current Process Engine administration and configuration objects.
static int IMPORT_REPLACE
          Value of 1. Indicates an import will replace current Process Engine administration and configuration objects.
 
Constructor Summary
VWXMLConfiguration()
           
 
Method Summary
static java.lang.String _get_FILE_AUTHOR()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_DATE()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_REVISION()
          For FileNet internal use only, do not call.
static void exportConfiguration(IVWtoXML[] apiObjects, java.lang.StringBuffer buffer)
          Creates an XML document in a StringBuffer representing the specified administration and configuration objects implementing the IVWtoXML interface.
static void exportConfigurationToFile(IVWtoXML[] apiObjects, java.lang.String outputFile)
          Creates an XML document file representing the specified administration and configuration objects implementing the IVWtoXML interface.
static java.lang.String importConfiguration(VWSession session, java.lang.String config, int option)
          Imports Process Engine administration and configuration properties from a String containing XML text representing the properties.
static java.lang.String importConfigurationFromFile(VWSession session, java.lang.String inputFile, int option)
          Imports Process Engine administration and configuration properties from an XML document.
static java.lang.String makeXMLBlock(IVWtoXML[] apiObjects)
          Creates XML header information and XML text representing the specified administration and configuration objects implementing the IVWtoXML interface.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IMPORT_REPLACE

public static final int IMPORT_REPLACE
Value of 1. Indicates an import will replace current Process Engine administration and configuration objects.

See Also:
Constant Field Values

IMPORT_MERGE

public static final int IMPORT_MERGE
Value of 2. Indicates import properties will be added to current Process Engine administration and configuration objects.

See Also:
Constant Field Values

IMPORT_EXCLUDE_USERINFO

public static final int IMPORT_EXCLUDE_USERINFO
Value of 16. Indicates exclusion of user info; the default is to import user info. This option can not be used alone. It must be combined (use bitwise inclusive OR) with either IMPORT_MERGE or IMPORT_REPLACE option

See Also:
Constant Field Values

ATTRINFO_CONFIG_ALLOW_USER_ENTER_WSDL

public static final java.lang.String ATTRINFO_CONFIG_ALLOW_USER_ENTER_WSDL
See Also:
Constant Field Values
Constructor Detail

VWXMLConfiguration

public VWXMLConfiguration()
Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


exportConfiguration

public static void exportConfiguration(IVWtoXML[] apiObjects,
                                       java.lang.StringBuffer buffer)
                                throws VWException
Creates an XML document in a StringBuffer representing the specified administration and configuration objects implementing the IVWtoXML interface.

Parameters:
apiObjects - An array of IVWtoXML objects representing the Process Engine administration and configuration objects.
buffer - A StringBuffer to which an XML representation of the objects (specified in apiObjects) will be written.
Throws:
VWException - Thrown for various causes, including when the StringBuffer for the XML cannot be created.

exportConfigurationToFile

public static void exportConfigurationToFile(IVWtoXML[] apiObjects,
                                             java.lang.String outputFile)
                                      throws VWException
Creates an XML document file representing the specified administration and configuration objects implementing the IVWtoXML interface.

Parameters:
apiObjects - An array of IVWtoXML objects representing the Process Engine administration and configuration objects.
outputFile - A String containing the name of the file to which an XML representation of the objects (specified in apiObjects) will be written.
Throws:
VWException - Thrown for various causes, including when the XML cannot be created for the outputFile.

importConfiguration

public static java.lang.String importConfiguration(VWSession session,
                                                   java.lang.String config,
                                                   int option)
                                            throws VWException
Imports Process Engine administration and configuration properties from a String containing XML text representing the properties.

Parameters:
session - A VWSession object for the identifying session.
config - A String containing the XML representation of the properties to import.
option - An integer indicating a valid import option.
Returns:
A String containing the import progress log.
Throws:
VWException - Thrown for various causes, including a null or empty string for the inputFile parameter, an invalid import option, or a null VWSession object.
See Also:
exportConfiguration(IVWtoXML[],StringBuffer)

importConfigurationFromFile

public static java.lang.String importConfigurationFromFile(VWSession session,
                                                           java.lang.String inputFile,
                                                           int option)
                                                    throws VWException
Imports Process Engine administration and configuration properties from an XML document.

Parameters:
session - A VWSession object for the identifying session.
inputFile - A String containing the name of the XML document file to import.
option - An integer indicating a valid import option.
Returns:
A String containing the import progress log.
Throws:
VWException - Thrown for various causes, including a null or empty string for the inputFile parameter, an invalid import option, or a null VWSession object.
See Also:
exportConfigurationToFile(IVWtoXML[],String)

makeXMLBlock

public static java.lang.String makeXMLBlock(IVWtoXML[] apiObjects)
                                     throws VWException
Creates XML header information and XML text representing the specified administration and configuration objects implementing the IVWtoXML interface.

You can create runtime XML blocks with VWXMLUtil.makeXMLBlock(IVWtoXML[],String).

Parameters:
apiObjects - An array of IVWtoXML objects representing the Process Engine administration and configuration objects.
Returns:
A String containing the XML representation of the Process Engine administration and configuration objects specified in apiObjects.
Throws:
VWException - Thrown for various causes, including an invalid object specified in the array for the apiObjects parameter.

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.