|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWXMLConfiguration
public final class VWXMLConfiguration
VWXMLConfiguration imports and exports XML text representing
Process Engine administration and configuration objects
that implement the IVWtoXML
interface.
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 |
---|
public static final int IMPORT_REPLACE
public static final int IMPORT_MERGE
public static final int IMPORT_EXCLUDE_USERINFO
public static final java.lang.String ATTRINFO_CONFIG_ALLOW_USER_ENTER_WSDL
Constructor Detail |
---|
public VWXMLConfiguration()
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public static void exportConfiguration(IVWtoXML[] apiObjects, java.lang.StringBuffer buffer) throws VWException
IVWtoXML
interface.
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.
VWException
- Thrown for various causes, including when the StringBuffer for the
XML cannot be created.public static void exportConfigurationToFile(IVWtoXML[] apiObjects, java.lang.String outputFile) throws VWException
IVWtoXML
interface.
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.
VWException
- Thrown for various causes, including when the XML cannot be
created for the outputFile.public static java.lang.String importConfiguration(VWSession session, java.lang.String config, int option) throws VWException
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.
VWException
- Thrown for various causes, including a null or empty string for the
inputFile
parameter, an invalid import option, or a null VWSession object.exportConfiguration(IVWtoXML[],StringBuffer)
public static java.lang.String importConfigurationFromFile(VWSession session, java.lang.String inputFile, int option) throws VWException
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.
VWException
- Thrown for various causes, including a null or empty string for the
inputFile
parameter, an invalid import option, or a null VWSession object.exportConfigurationToFile(IVWtoXML[],String)
public static java.lang.String makeXMLBlock(IVWtoXML[] apiObjects) throws VWException
IVWtoXML
interface.
You can create runtime XML blocks with VWXMLUtil.makeXMLBlock(IVWtoXML[],String)
.
apiObjects
- An array of IVWtoXML objects representing the Process Engine administration and
configuration objects.
apiObjects
.
VWException
- Thrown for various causes, including an
invalid object specified in the array for the apiObjects
parameter.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |