Process Class Relationships

filenet.vw.api
Class VWLoggingOptionType

java.lang.Object
  |
  +--filenet.vw.api.VWLoggingOptionType

public final class VWLoggingOptionType
extends java.lang.Object

Use this class to set the option type for logging a message on the server. Specify one of the following values as an input for the logMessage of an Instruction Element:


Refer to the Field Detail descriptions (below) for more information about the logging options.

Since:
VWWS3.10
See Also:
VWInstructionElement, VWStepElement, VWWorkObject, VWLogElement.getEventType()

Field Summary
static int LOGGING_OPTION_TYPE_USER1_MESSAGE1
          Integer value of 410. Specifies this optionlogs message 1 of user 1 on the server.
static int LOGGING_OPTION_TYPE_USER1_MESSAGE2
          Integer value of 420. Specifies this optionlogs message 2 of user 1 on the server.
static int LOGGING_OPTION_TYPE_USER1_MESSAGE3
          Integer value of 430. Specifies this optionlogs message 3 of user 1 on the server.
static int LOGGING_OPTION_TYPE_USER1_MESSAGE4
          Integer value of 440. Specifies this optionlogs message 4 of user 1 on the server.
static int LOGGING_OPTION_TYPE_USER2_MESSAGE1
          Integer value of 450. Specifies this optionlogs message 1 of user 2 on the server.
static int LOGGING_OPTION_TYPE_USER2_MESSAGE2
          Integer value of 460. Specifies this optionlogs message 2 of user 2 on the server.
static int LOGGING_OPTION_TYPE_USER2_MESSAGE3
          Integer value of 470. Specifies this optionlogs message 3 of user 2 on the server.
static int LOGGING_OPTION_TYPE_USER2_MESSAGE4
          Integer value of 480. Specifying this option logs message 4 of user 2 on the server.
 
Constructor Summary
VWLoggingOptionType()
           
 
Method Summary
static java.lang.String getLocalizedString(int loggingOptionType)
          Gets a localized String representation of the logging option type.
static boolean isUserLoggingOption(int loggingOptionType)
          Determines whether or not the logging option type is one of the available user log message types.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOGGING_OPTION_TYPE_USER1_MESSAGE1

public static final int LOGGING_OPTION_TYPE_USER1_MESSAGE1
Integer value of 410. Specifies this optionlogs message 1 of user 1 on the server.

LOGGING_OPTION_TYPE_USER1_MESSAGE2

public static final int LOGGING_OPTION_TYPE_USER1_MESSAGE2
Integer value of 420. Specifies this optionlogs message 2 of user 1 on the server.

LOGGING_OPTION_TYPE_USER1_MESSAGE3

public static final int LOGGING_OPTION_TYPE_USER1_MESSAGE3
Integer value of 430. Specifies this optionlogs message 3 of user 1 on the server.

LOGGING_OPTION_TYPE_USER1_MESSAGE4

public static final int LOGGING_OPTION_TYPE_USER1_MESSAGE4
Integer value of 440. Specifies this optionlogs message 4 of user 1 on the server.

LOGGING_OPTION_TYPE_USER2_MESSAGE1

public static final int LOGGING_OPTION_TYPE_USER2_MESSAGE1
Integer value of 450. Specifies this optionlogs message 1 of user 2 on the server.

LOGGING_OPTION_TYPE_USER2_MESSAGE2

public static final int LOGGING_OPTION_TYPE_USER2_MESSAGE2
Integer value of 460. Specifies this optionlogs message 2 of user 2 on the server.

LOGGING_OPTION_TYPE_USER2_MESSAGE3

public static final int LOGGING_OPTION_TYPE_USER2_MESSAGE3
Integer value of 470. Specifies this optionlogs message 3 of user 2 on the server.

LOGGING_OPTION_TYPE_USER2_MESSAGE4

public static final int LOGGING_OPTION_TYPE_USER2_MESSAGE4
Integer value of 480. Specifying this option logs message 4 of user 2 on the server.
Constructor Detail

VWLoggingOptionType

public VWLoggingOptionType()
Method Detail

isUserLoggingOption

public static boolean isUserLoggingOption(int loggingOptionType)
Determines whether or not the logging option type is one of the available user log message types. (LOGGING_OPTION_TYPE_USER1_MESSAGE1 through LOGGING_OPTION_TYPE_USER2_MESSAGE4).
Parameters:
loggingOptionType - An integer value associated with the logging option type being validated.
Returns:
A Boolean value. The method returns true if the value specified in the loggingOptionType parameter is valid; otherwise, the method returns false.

getLocalizedString

public static java.lang.String getLocalizedString(int loggingOptionType)
                                           throws VWException
Gets a localized String representation of the logging option type.
Parameters:
loggingOptionType - An integer value for the logging option type.
Returns:
The localized string representation of the logging option type. If the specified loggingOptionType parameter is not a recognized logging event value, the method returns an UnknownEvent message string.
Throws:
VWException - Thrown for low-level system errors.
See Also:
VWLogElement.getEventType()

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.