filenet.vw.api
Class VWModeType
java.lang.Object
|
+--filenet.vw.api.VWModeType
- public final class VWModeType
- extends java.lang.Object
Use this class to specify a directional attribute of an object such as,
for example, a parameter of an operation or a step.
The valid argument mode types are as following:
- 1: Input parameter, which is passed by value (MODE_TYPE_IN).
- 2: Output parameter (MODE_TYPE_OUT).
- 3: Input/Output parameter, which is passed by reference
(MODE_TYPE_IN_OUT).
Field Summary |
static int |
MODE_TYPE_IN
Value of 1. Indicates that the argument is an
input parameter, which is passed by value. |
static int |
MODE_TYPE_IN_OUT
Value of 3. Indicates that the argument is an
input/output parameter, which is passed by reference. |
static int |
MODE_TYPE_OUT
Value of 2. Indicates that the argument is an
output parameter, which is passed by reference. |
Method Summary |
static java.lang.String |
getLocalizedString(int theModeType)
Gets a localized string representation of the mode type. |
static boolean |
isValid(int theModeType)
Validates the mode type. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
MODE_TYPE_IN
public static final int MODE_TYPE_IN
- Value of 1. Indicates that the argument is an
input parameter, which is passed by value.
MODE_TYPE_OUT
public static final int MODE_TYPE_OUT
- Value of 2. Indicates that the argument is an
output parameter, which is passed by reference.
MODE_TYPE_IN_OUT
public static final int MODE_TYPE_IN_OUT
- Value of 3. Indicates that the argument is an
input/output parameter, which is passed by reference.
VWModeType
public VWModeType()
getLocalizedString
public static java.lang.String getLocalizedString(int theModeType)
throws VWException
- Gets a localized string representation of the mode type.
- Parameters:
theModeType
- An integer value associated with the
mode type value to be represented by a string.- Returns:
- The localized string representation
of the mode type.
- Throws:
VWException
- The method throws an exception if the
integer value mode type specified is invalid.
isValid
public static boolean isValid(int theModeType)
- Validates the mode type.
- Parameters:
theModeType
- An integer associated with the mode
type value to be validated.- Returns:
- A boolean value. The method returns
true
if the
integer value specified in the theModeType parameter is valid;
otherwise, the method returns false
.
Copyright © 2002, 2003 FileNet Corporation. All rights reserved.