Process API

filenet.vw.api
Class VWSystemConfiguration

java.lang.Object
  extended by filenet.vw.api.VWSystemConfiguration
All Implemented Interfaces:
IVWtoXML, java.io.Serializable

public final class VWSystemConfiguration
extends java.lang.Object
implements java.io.Serializable, IVWtoXML

Use this class to access configuration information for an isolated region. The configuration information includes the queues, rosters, logs, and region-wide configuration values for the current isolated region. Create an instance of this class by calling the VWSession.fetchSystemConfiguration() method.

Once you are done creating and/or modifying configuration values, call the VWSystemConfiguration.commit() method to commit changes (update the workspace) on the server.

Since:
eProcess 4.0
See Also:
VWSession.fetchSystemConfiguration(), VWLogDefinition, VWQueueDefinition, VWRosterDefinition, Serialized Form

Field Summary
static int LOG_ALL
          Integer value that is the sum of all the other logging options. Enables logging for all selections.
static int LOG_BEGIN_SERVICE_OPERATION
          Value of 0x00100000 (1048576 decimal). Enables logging when a work performer and work object begin operation.
static int LOG_END_SERVICE_OPERATION
          Value of 0x00400000 (4194304 decimal). Enables logging when work performer and work object end operation.
static int LOG_MILESTONES
          Value of 0x00000040 (64 decimal). Enables logging for milestones.
static int LOG_NONE
          Value of 0. Disables logging for all selections.
static int LOG_SYSTEM_MESSAGES
          Value of 0x00010000 (65536 decimal). Enables logging for system messages.
static int LOG_USER_DEFINED_1
          Value of 0x40000000 (1073741824 decimal). Enables logging for user-defined message 1.
static int LOG_USER_DEFINED_2
          Value of 0x80000000 (2147483648 decimal). Enables logging for user-defined message 2.
static int LOG_WOBJ_ADMINISTRATION
          Value of 0x00001000 ( 4096 decimal). Enables logging for work object administration messages.
static int LOG_WOBJ_CREATION
          Value of 0x00000100 (256 decimal). Enables logging for work object creation.
static int LOG_WOBJ_EMPTY_STEP
          Value of 0x00000010 (16 decimal). Enables logging for empty steps, (steps with no queue or participants).
static int LOG_WOBJ_EXCEPTION
          Value of 0x00000400 (1024 decimal). Enables logging for work object exceptions.
static int LOG_WOBJ_RULES
          Value of 0x00000020 (32 decimal). Enables logging for work object rules.
static int LOG_WOBJ_TERMINATION
          Value of 0x00000200 (512 decimal). Enables logging for work object termination.
static int LOG_WOBJ_TRACE_INSTRUCTIONS
          Value of 0x00000080 (128 decimal). Enables logging for work object trace instructions.
 
Constructor Summary
VWSystemConfiguration()
           
 
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.
 java.lang.String[] commit()
          Saves system configuration changes to the current isolated region.
 VWApplicationSpaceDefinition createApplicationSpaceDefinition(java.lang.String name)
          Creates an application space definition.
 VWLogDefinition createLogDefinition(java.lang.String theName)
          Creates a log definition.
 VWQueueDefinition createQueueDefinition(java.lang.String theName, int theQueueType)
          Creates a queue definition.
 VWRosterDefinition createRosterDefinition(java.lang.String theName)
          Creates a roster definition.
 VWStepProcessorInfoDefinition createStepProcessorInfoDefinition()
          Creates a step processor definition.
 void deleteStepProcessorInfoDefinition(VWStepProcessorInfoDefinition theSPDef)
          Deletes a step processor info definition.
 VWApplicationSpaceDefinition getApplicationSpaceDefinition(java.lang.String name)
          Gets an application space definition.
 VWApplicationSpaceDefinition[] getApplicationSpaceDefinitions()
          Gets all of the application space definitions associated with this system configuration.
 VWAttributeInfo getAttributeInfo()
          Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
 VWLogDefinition getDefaultLogDefinition()
          Gets the default definition for event logging.
 VWExposedFieldDefinition[] getExposedFields()
          Returns all the exposed fields on the queues, the rosters, and the logs.
static java.lang.String getLocalizedString(int theLogType)
          Gets a localized String representation of the log type.
 VWLogDefinition getLogDefinition(java.lang.String name)
          Gets a log definition, specified by name.
 VWLogDefinition[] getLogDefinitions()
          Gets the log definitions associated with this system configuration object.
 int getLoggingState()
          Gets the value of all the logging states.
 boolean getLoggingState(int theLoggingOption)
          Determines whether or not a logging option is enabled or disabled.
 int getMaxDBOperations()
          Gets the current maximum number of database operations per transaction.
 int getMaxInstructions()
          Gets the current maximum number of instructions per transaction.
 VWQueueDefinition getQueueDefinition(java.lang.String name)
          Gets the queue definition with with specified name, for the current isolated region.
 VWQueueDefinition[] getQueueDefinitions()
          Lists all queue definitions for the current configuration.
 VWRosterDefinition getRosterDefinition(java.lang.String name)
          Gets the roster definition with specified name.
 VWRosterDefinition[] getRosterDefinitions()
          Gets the roster definitions associated with the current isolated region.
 java.lang.Integer[] getServerIDs()
          Lists the all available server IDs.
 boolean getStatisticsCollection()
          Gets the current state of the statistics collection option.
 VWStepProcessorInfoDefinition getStepProcessorInfoDefinition(java.lang.String name)
          Gets a step processor info definition, specified by name.
 VWStepProcessorInfoDefinition[] getStepProcessorInfoDefinitions()
          Gets the VWStepProcessorInfoDefinition objects associated with this system configuration object.
 boolean getTrackAttachmentReferences()
          Gets the current state, enabled or disabled, of the attachment tracking option.
 void setAttributeInfo(VWAttributeInfo theAttributeInfo)
          Sets a VWAttribute object containing attributes for this object.
 int setLoggingState(int newLoggingOptions, boolean turnOn)
          Enables or disables system logging options.
 void setMaxDBOperations(int theMaxOperations)
          Sets the maximum number of database operations executed by the instruction sheet interpreter per transaction, which is used to maximize throughput between the workstation and the server.
 void setMaxInstructions(int theMaxInstructions)
          Sets the maximum number of instructions executed by the instruction sheet interpreter per transaction, which is used to maximize throughput between the workstation and server.
 void setStatisticsCollection(boolean turnOn)
          Enables or disables the statistics gathering.
 void setTrackAttachmentReferences(boolean turnOn)
          Enables or disables the tracking of attachment references.
 java.lang.String toString()
          Gets the String representation of the VWSystemConfiguration object.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string representing this instance to the buffer specified.
 void updateApplicationSpaceDefinition(VWApplicationSpaceDefinition theApplicationSpaceDef)
          Updates an application space definition.
 void updateLogDefinition(VWLogDefinition theLogDefinition)
          Updates a log definition.
 void updateQueueDefinition(VWQueueDefinition theQueueDefinition)
          Updates a queue definition.
 void updateRosterDefinition(VWRosterDefinition theRosterDefinition)
          Updates a roster definition.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LOG_NONE

public static final int LOG_NONE
Value of 0. Disables logging for all selections. Refer to the setLoggingState(int, boolean) method for information on setting the logging options.

See Also:
Constant Field Values

LOG_WOBJ_CREATION

public static final int LOG_WOBJ_CREATION
Value of 0x00000100 (256 decimal). Enables logging for work object creation. Refer to the setLoggingState(int, boolean) method for information on setting the logging options.

See Also:
Constant Field Values

LOG_WOBJ_TERMINATION

public static final int LOG_WOBJ_TERMINATION
Value of 0x00000200 (512 decimal). Enables logging for work object termination. Refer to the setLoggingState(int, boolean) method for more information.

See Also:
Constant Field Values

LOG_WOBJ_EXCEPTION

public static final int LOG_WOBJ_EXCEPTION
Value of 0x00000400 (1024 decimal). Enables logging for work object exceptions. Refer to the setLoggingState(int, boolean) method for more information.

See Also:
Constant Field Values

LOG_WOBJ_ADMINISTRATION

public static final int LOG_WOBJ_ADMINISTRATION
Value of 0x00001000 ( 4096 decimal). Enables logging for work object administration messages. Refer to the setLoggingState(int, boolean) method for more information.

See Also:
Constant Field Values

LOG_WOBJ_TRACE_INSTRUCTIONS

public static final int LOG_WOBJ_TRACE_INSTRUCTIONS
Value of 0x00000080 (128 decimal). Enables logging for work object trace instructions. Refer to the setLoggingState(int, boolean) method for more information.

See Also:
Constant Field Values

LOG_WOBJ_EMPTY_STEP

public static final int LOG_WOBJ_EMPTY_STEP
Value of 0x00000010 (16 decimal). Enables logging for empty steps, (steps with no queue or participants). Refer to the setLoggingState(int, boolean) method for more information.

See Also:
Constant Field Values

LOG_WOBJ_RULES

public static final int LOG_WOBJ_RULES
Value of 0x00000020 (32 decimal). Enables logging for work object rules. Refer to the setLoggingState(int, boolean) method for more information.

See Also:
Constant Field Values

LOG_BEGIN_SERVICE_OPERATION

public static final int LOG_BEGIN_SERVICE_OPERATION
Value of 0x00100000 (1048576 decimal). Enables logging when a work performer and work object begin operation. Refer to the setLoggingState(int, boolean) method for more information.

See Also:
Constant Field Values

LOG_END_SERVICE_OPERATION

public static final int LOG_END_SERVICE_OPERATION
Value of 0x00400000 (4194304 decimal). Enables logging when work performer and work object end operation. Refer to the setLoggingState(int, boolean) method for more information.

See Also:
Constant Field Values

LOG_USER_DEFINED_1

public static final int LOG_USER_DEFINED_1
Value of 0x40000000 (1073741824 decimal). Enables logging for user-defined message 1. Refer to the setLoggingState(int, boolean) method for more information.

See Also:
Constant Field Values

LOG_USER_DEFINED_2

public static final int LOG_USER_DEFINED_2
Value of 0x80000000 (2147483648 decimal). Enables logging for user-defined message 2. Refer to the setLoggingState(int, boolean) method for more information.

See Also:
Constant Field Values

LOG_SYSTEM_MESSAGES

public static final int LOG_SYSTEM_MESSAGES
Value of 0x00010000 (65536 decimal). Enables logging for system messages. Refer to the setLoggingState(int, boolean) method for information on setting the logging options.

See Also:
Constant Field Values

LOG_MILESTONES

public static final int LOG_MILESTONES
Value of 0x00000040 (64 decimal). Enables logging for milestones. Refer to the setLoggingState(int, boolean) method for information on setting the logging options.

See Also:
Constant Field Values

LOG_ALL

public static final int LOG_ALL
Integer value that is the sum of all the other logging options. Enables logging for all selections. Refer to the setLoggingState(int, boolean) method for information on setting the logging options.

See Also:
Constant Field Values
Constructor Detail

VWSystemConfiguration

public VWSystemConfiguration()
Method Detail

_get_FILE_DATE

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

Returns:
the file date

_get_FILE_AUTHOR

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

Returns:
the file author

_get_FILE_REVISION

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

Returns:
the file revision

commit

public java.lang.String[] commit()
                          throws VWException
Saves system configuration changes to the current isolated region.

Before calling this method, configuration changes reside only in local memory. The workflow system suspends all database transactions within the isolated region until the commit is complete. For this reason, you should call this method when the current isolated region is relatively inactive.

Note: Depending on your application and the calls you are making, you may need to adjust the client timeout value in your Java initiation statement prior to calling this method. For example, under Sun Solaris or using the Sun JVM, you may need to adjust the timeout value in the Java initiation statement as follows:

     -Dcom.sun.CORBA.transport.ORBTCPReadTimeouts=100:15000:300:5
 

Returns:
An array of Strings in which each String represents an error encountered while the system attempted to transfer the settings. If the method does not encounter errors, the String contains a null value.
Throws:
VWException - Thrown if the system encounters an error while attempting to transfer the system configuration to the online repository.

createQueueDefinition

public VWQueueDefinition createQueueDefinition(java.lang.String theName,
                                               int theQueueType)
                                        throws VWException
Creates a queue definition.

Parameters:
theName - The queue name, which should conform to the following the guidelines:

  • Begin with an alphabetic character.
  • Not begin with "F_".
  • Contain 31 or fewer characters.
  • Not include special characters.
  • Be alphanumeric (underscores are acceptable after the first letter in the name).

theQueueType - An integer value specifying the type of the queue, as defined in VWQueueDefinition class.

Valid values are as follows:

  • 1: Process (QUEUE_TYPE_PROCESS)
  • 2: User-centric (QUEUE_TYPE_USER_CENTRIC)

Returns:
A VWQueueDefinition object that represents the new queue.
Throws:
VWException - Causes include situations where a queue with the name specified in the theName parameter already exists, the queue name specified is invalid because it violates naming conventions, or the queue type specified in the theQueueType parameter is something other than QUEUE_TYPE_PROCESS or QUEUE_TYPE_USER_CENTRIC.
See Also:
VWQueueDefinition

updateQueueDefinition

public void updateQueueDefinition(VWQueueDefinition theQueueDefinition)
                           throws VWException
Updates a queue definition.

Parameters:
theQueueDefinition - The updated queue definition.
Throws:
VWException - Causes include situations where the queue definition does not exist or is invalid.
See Also:
VWQueueDefinition

getQueueDefinitions

public VWQueueDefinition[] getQueueDefinitions()
                                        throws VWException
Lists all queue definitions for the current configuration.

Returns:
An array of VWQueueDefinition objects. Each object represents a queue definition for this isolated region.
Throws:
VWException

getQueueDefinition

public VWQueueDefinition getQueueDefinition(java.lang.String name)
                                     throws VWException
Gets the queue definition with with specified name, for the current isolated region.

Parameters:
name - Name of the queue definition.
Returns:
A VWQueueDefinition object associated with the current isolated region, or null if the queue definition does not exist.
Throws:
VWException - Thrown if this method cannot get the named, existing log definition associated with the current isolated region.

getDefaultLogDefinition

public VWLogDefinition getDefaultLogDefinition()
                                        throws VWException
Gets the default definition for event logging.

Returns:
A VWLogDefinition object that represents the default log definition for this isolated region, or null if there is no default log definition.
Throws:
VWException
See Also:
VWLogDefinition

createLogDefinition

public VWLogDefinition createLogDefinition(java.lang.String theName)
                                    throws VWException
Creates a log definition.

Parameters:
theName - A String containing the name of the log definition.
Returns:
A VWLogDefinition object that represents the newly created log definition.
Throws:
VWException - Thrown if the log name specified in the theName parameter already exists or if the system encounters an error while attempting to create the log.
See Also:
VWLogDefinition

updateLogDefinition

public void updateLogDefinition(VWLogDefinition theLogDefinition)
                         throws VWException
Updates a log definition.

Parameters:
theLogDefinition - The updated log definition.
Throws:
VWException - Thrown if the log definition does not exist or if the system encounters an error while attempting to update the log definition.
See Also:
VWLogDefinition

getLogDefinitions

public VWLogDefinition[] getLogDefinitions()
                                    throws VWException
Gets the log definitions associated with this system configuration object.

Returns:
An array of VWLogDefinition objects associated with the current isolated region.
Throws:
VWException - Thrown if this method cannot get the log definitions associated with this system.

getLogDefinition

public VWLogDefinition getLogDefinition(java.lang.String name)
                                 throws VWException
Gets a log definition, specified by name.

Parameters:
name - Name of the log definition.
Returns:
A VWLogDefinition object associated with the current isolated region, or null if the named log definition does not exist.
Throws:
VWException - Thrown if the method cannot get the log definitions associated with this system.

createRosterDefinition

public VWRosterDefinition createRosterDefinition(java.lang.String theName)
                                          throws VWException
Creates a roster definition.

Parameters:
theName - A String containing the name to be used for the roster definition.
Returns:
A VWRosterDefinition object that represents the newly created roster definition.
Throws:
VWException - Thrown if the roster name specified in the theName parameter already exists or if the system cannot create the roster.
See Also:
VWRosterDefinition

updateRosterDefinition

public void updateRosterDefinition(VWRosterDefinition theRosterDefinition)
                            throws VWException
Updates a roster definition.

Parameters:
theRosterDefinition - The updated roster definition.
Throws:
VWException - Thrown if the roster definition does not exist or if the system encounters an error while attempting to update the roster definition.
See Also:
VWRosterDefinition

getRosterDefinitions

public VWRosterDefinition[] getRosterDefinitions()
                                          throws VWException
Gets the roster definitions associated with the current isolated region.

Returns:
An array of VWRosterDefinition objects associated with the current isolated region.
Throws:
VWException

getRosterDefinition

public VWRosterDefinition getRosterDefinition(java.lang.String name)
                                       throws VWException
Gets the roster definition with specified name.

Parameters:
name - Name of the roster definition.
Returns:
A VWRosterDefinition object associated with the current isolated region, or null if the roster definition does not exist.
Throws:
VWException - Thrown

createStepProcessorInfoDefinition

public VWStepProcessorInfoDefinition createStepProcessorInfoDefinition()
                                                                throws VWException
Creates a step processor definition.

Returns:
A VWStepProcessorInfoDefinition object for the step processor definition.
Throws:
VWException
See Also:
VWStepProcessorInfoDefinition

deleteStepProcessorInfoDefinition

public void deleteStepProcessorInfoDefinition(VWStepProcessorInfoDefinition theSPDef)
                                       throws VWException
Deletes a step processor info definition.

Parameters:
theSPDef - A VWStepProcessorInfoDefinition object reference that represents the step processor definition to be deleted.
Throws:
VWException - Thrown if the method cannot delete a step processor info definition.
See Also:
VWStepProcessorInfoDefinition

getStepProcessorInfoDefinitions

public VWStepProcessorInfoDefinition[] getStepProcessorInfoDefinitions()
                                                                throws VWException
Gets the VWStepProcessorInfoDefinition objects associated with this system configuration object.

Returns:
An array of VWStepProcessorInfoDefinition objects associated with the current isolated region.
Throws:
VWException

getStepProcessorInfoDefinition

public VWStepProcessorInfoDefinition getStepProcessorInfoDefinition(java.lang.String name)
                                                             throws VWException
Gets a step processor info definition, specified by name.

Parameters:
name - Name of the step processor info definition.
Returns:
A VWStepProcessorInfoDefinition object associated with the current isolated region, or null if the queue definition does not exist.
Throws:
VWException - Thrown if the method cannot get the log definitions associated with with the current isolated region.

createApplicationSpaceDefinition

public VWApplicationSpaceDefinition createApplicationSpaceDefinition(java.lang.String name)
                                                              throws VWException
Creates an application space definition.

Parameters:
name - A String containing the name to assign to the application space definition.
Returns:
The VWApplicationSpaceDefinition object for the new application space definition.
Throws:
VWException
Since:
P8 4.5.0
See Also:
VWApplicationSpaceDefinition

updateApplicationSpaceDefinition

public void updateApplicationSpaceDefinition(VWApplicationSpaceDefinition theApplicationSpaceDef)
                                      throws VWException
Updates an application space definition.

Parameters:
theApplicationSpaceDef - A VWApplicationSpaceDefinition object for the application space to update.
Throws:
VWException - Thrown if the application space definition does not exist, or if the system encounters an error while attempting to update the application space definition.
Since:
P8 4.5.0
See Also:
VWApplicationSpaceDefinition

getApplicationSpaceDefinitions

public VWApplicationSpaceDefinition[] getApplicationSpaceDefinitions()
                                                              throws VWException
Gets all of the application space definitions associated with this system configuration.

Returns:
An array of VWApplicationSpaceDefinition objects associated with the current isolated region.
Throws:
VWException
Since:
P8 4.5.0

getApplicationSpaceDefinition

public VWApplicationSpaceDefinition getApplicationSpaceDefinition(java.lang.String name)
                                                           throws VWException
Gets an application space definition.

Parameters:
name - A String containing the name of the application space.
Returns:
A VWApplicationSpaceDefinition object associated with the current isolated region, or null if the specified application space definition does not exist.
Throws:
VWException - Thrown if the method cannot get the application space definition associated with with the current isolated region.
Since:
P8 4.5.0

getLoggingState

public boolean getLoggingState(int theLoggingOption)
Determines whether or not a logging option is enabled or disabled.

Parameters:
theLoggingOption - An integer value that specifies the logging options to check. Valid logging option values are as follows:

Returns:
A boolean value. This method returns true if the logging option specified in the theLoggingOption parameter is enabled currently; otherwise, this method returns false.

getLoggingState

public int getLoggingState()
Gets the value of all the logging states.

Returns:
An integer value that represents the logging state for the system. This value is the sum of the individual logging state values in the current instance of the VWSystemConfiguration class.

setLoggingState

public int setLoggingState(int newLoggingOptions,
                           boolean turnOn)
                    throws VWException
Enables or disables system logging options.

Parameters:
newLoggingOptions - An integer value specifying the logging options to enable or disable. Combine multiple options by summing them. Valid logging option values are as follows:

turnOn - A boolean value. Set to 'TRUE' to turn logging on for the options represented by the newLoggingOptions parameter.
Set to 'FALSE' to turn off logging for the options represented by the theLoggingOptions parameter.

If LOG_ALL is passed in and turnOn is 'FALSE', then logging options are set to LOG_NONE. If LOG_NONE is passed in and turnOn is 'FALSE', then logging options are set to LOG_ALL.

Returns:
An integer that represents the logging options that resulted from this method call.
Throws:
VWException - Thrown if the method cannot enable or disable system logging options. This can occur if a logging option is invalid, for example.

getMaxDBOperations

public int getMaxDBOperations()
Gets the current maximum number of database operations per transaction.

Returns:
An integer value indicating the current number of allowed database operation for each workflow transaction.

setMaxDBOperations

public void setMaxDBOperations(int theMaxOperations)
Sets the maximum number of database operations executed by the instruction sheet interpreter per transaction, which is used to maximize throughput between the workstation and the server.

Parameters:
theMaxOperations - An integer value specifying the maximum number of database operations per transaction
See Also:
getMaxDBOperations()

getMaxInstructions

public int getMaxInstructions()
Gets the current maximum number of instructions per transaction.

Returns:
Current maximum number of instructions per transaction

setMaxInstructions

public void setMaxInstructions(int theMaxInstructions)
Sets the maximum number of instructions executed by the instruction sheet interpreter per transaction, which is used to maximize throughput between the workstation and server.

Parameters:
theMaxInstructions - An integer representing the maximum number of instructions per transaction.
See Also:
getMaxInstructions()

getServerIDs

public java.lang.Integer[] getServerIDs()
Lists the all available server IDs.

Returns:
An array of integers values that represent the server Ids for each server.

getStatisticsCollection

public boolean getStatisticsCollection()
Gets the current state of the statistics collection option.

Returns:
A boolean value. This method returns true if statistic collection is enabled currently. This method returns false if statistic collection is disabled.

setStatisticsCollection

public void setStatisticsCollection(boolean turnOn)
Enables or disables the statistics gathering.

Parameters:
turnOn - A boolean value. Specify true to enable collection of statistical information; specify false to disable collection of statistical information.

getTrackAttachmentReferences

public boolean getTrackAttachmentReferences()
Gets the current state, enabled or disabled, of the attachment tracking option.

Note: When attachment tracking is turned on, only the first 256 bytes are used for tracking purposes. Normally, only IDs that are a URL or UNC are this long. This tracking feature does not limit the ID field within an attachment or attachment object, itself.

Returns:
true if attachment tracking is currently enabled; false if tracking of attachments is disabled.

setTrackAttachmentReferences

public void setTrackAttachmentReferences(boolean turnOn)
Enables or disables the tracking of attachment references.

Note: When attachment tracking is turned on, the internal ID of attachment being tracked is limited to 256 bytes. If the attachment ID is longer than 256 bytes, the ID will be truncated to the first 256 bytes.

Parameters:
turnOn - A boolean value. Specify true to enable tracking of attachment references; specify false to disable tracking of attachment references.

getLocalizedString

public static java.lang.String getLocalizedString(int theLogType)
                                           throws VWException
Gets a localized String representation of the log type.

Parameters:
theLogType - An integer value that represents the log type to be represented by a String. Valid logging option values are as follows:

Returns:
A String containing the localized text representation of the log type.
Throws:
VWException - Thrown if the log type specified in the theLogType parameter is invalid.

getExposedFields

public VWExposedFieldDefinition[] getExposedFields()
                                            throws VWException
Returns all the exposed fields on the queues, the rosters, and the logs.

Returns:
An array of VWExposedFieldDefinition objects that define all queue, roster, and log definitions for the current system configuration.
Throws:
VWException

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.

Returns:
A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Throws:
VWException
See Also:
setAttributeInfo(filenet.vw.api.VWAttributeInfo)

setAttributeInfo

public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
Sets a VWAttribute object containing attributes for this object.

Parameters:
theAttributeInfo - A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Throws:
VWException
See Also:
getAttributeInfo()

toString

public java.lang.String toString()
Gets the String representation of the VWSystemConfiguration object.

Overrides:
toString in class java.lang.Object
Returns:
The name of the current isolated region.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Specified by:
toXML in interface IVWtoXML
Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

Process API

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