Process API

filenet.vw.api
Class VWLibraryType

java.lang.Object
  extended by filenet.vw.api.VWLibraryType

public final class VWLibraryType
extends java.lang.Object

Use this class to determine whether the library or Object Store type is Image Services, Content Services, or undefined.

Since:
VWWS3.10

Field Summary
static int LIBRARY_TYPE_CM
           
static int LIBRARY_TYPE_CONTENT_ENGINE
          Value of 3. The library or Object Store is a Content Engine library.
static int LIBRARY_TYPE_GENERIC
           
static int LIBRARY_TYPE_IDMDS
          Value of 2. The library is a Content Services (CS) library (Content Services was formerly known as Document Services).
static int LIBRARY_TYPE_IDMIS
          Value of 1. The library is an Image Services (IS) library.
static int LIBRARY_TYPE_OD
           
static int LIBRARY_TYPE_UNDEFINED
          Value of 0. The library type is unknown or undefined.
 
Constructor Summary
VWLibraryType()
           
 
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 theLibraryType)
          Gets a localized string containing a description of the library or Object Store type.
static boolean isValid(int theLibraryType)
          Validates the specified library or Object Store type.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LIBRARY_TYPE_UNDEFINED

public static final int LIBRARY_TYPE_UNDEFINED
Value of 0. The library type is unknown or undefined.

See Also:
Constant Field Values

LIBRARY_TYPE_IDMIS

public static final int LIBRARY_TYPE_IDMIS
Value of 1. The library is an Image Services (IS) library.

See Also:
Constant Field Values

LIBRARY_TYPE_IDMDS

public static final int LIBRARY_TYPE_IDMDS
Value of 2. The library is a Content Services (CS) library (Content Services was formerly known as Document Services).

See Also:
Constant Field Values

LIBRARY_TYPE_CONTENT_ENGINE

public static final int LIBRARY_TYPE_CONTENT_ENGINE
Value of 3. The library or Object Store is a Content Engine library.

See Also:
Constant Field Values

LIBRARY_TYPE_CM

public static final int LIBRARY_TYPE_CM
See Also:
Constant Field Values

LIBRARY_TYPE_OD

public static final int LIBRARY_TYPE_OD
See Also:
Constant Field Values

LIBRARY_TYPE_GENERIC

public static final int LIBRARY_TYPE_GENERIC
See Also:
Constant Field Values
Constructor Detail

VWLibraryType

public VWLibraryType()
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 theLibraryType)
                                           throws VWException
Gets a localized string containing a description of the library or Object Store type.

Parameters:
theLibraryType - An integer value associated with the or Object Store or library type.
Returns:
The localized description of the Object Store or library type.
Throws:
VWException - The method throws an exception if the Object Store or library type integer value specified in the theLibraryType parameter is invalid.

isValid

public static boolean isValid(int theLibraryType)
Validates the specified library or Object Store type.

Parameters:
theLibraryType - An integer value for the library or Object Store type.
Returns:
A Boolean value. The method returns true if the integer value specified in the theLibraryType parameter is valid; otherwise, the method returns false.

Process API

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