Process API

filenet.vw.api
Class VWModeType

java.lang.Object
  extended by 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:


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.
 
Constructor Summary
VWModeType()
           
 
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 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
 

Field Detail

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.

See Also:
Constant Field Values

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.

See Also:
Constant Field Values

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.

See Also:
Constant Field Values
Constructor Detail

VWModeType

public VWModeType()
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.


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.

Process API

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