filenet.vw.api

Class VWAttachmentType

java.lang.Object

filenet.vw.api.VWAttachmentType

public final class VWAttachmentType
extends java.lang.Object

Use this class to access the type information for an attachment.

Since:

VWWS3.10

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTACHMENT_TYPE_CUSTOM_OBJECT Value of 6: indicating the attachment type is a Custom object.
static int	ATTACHMENT_TYPE_DOCUMENT Value of 3: indicating the attachment is the document type.
static int	ATTACHMENT_TYPE_FOLDER Value of 2: indicating the attachment is the folder type.
static int	ATTACHMENT_TYPE_LIBRARY Value of 1: indicating the attachment type is library or Object Store.
static int	ATTACHMENT_TYPE_STORED_SEARCH Value of 4: indicating the attachment is the stored search type.
static int	ATTACHMENT_TYPE_TASK Value of 7: indicating the attachment type is a Task object.
static int	ATTACHMENT_TYPE_UNDEFINED Value of 0: indicating the attachment type is not known.
static int	ATTACHMENT_TYPE_URL Value of 5: indicating the attachment type is a UNC or URL.

Constructor Summary

Constructors

Constructor and Description
VWAttachmentType()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getLocalizedString(int theAttachmentType) Gets a localized string associated with a valid attachment type integer value.
static boolean	isValid(int theAttachmentType) Validates whether the input value is a valid attachment type.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ATTACHMENT_TYPE_UNDEFINED

public static final int ATTACHMENT_TYPE_UNDEFINED

Value of 0: indicating the attachment type is not known.

See Also:

Constant Field Values

ATTACHMENT_TYPE_LIBRARY

public static final int ATTACHMENT_TYPE_LIBRARY

Value of 1: indicating the attachment type is library or Object Store.

See Also:

Constant Field Values

ATTACHMENT_TYPE_FOLDER

public static final int ATTACHMENT_TYPE_FOLDER

Value of 2: indicating the attachment is the folder type.

See Also:

Constant Field Values

ATTACHMENT_TYPE_DOCUMENT

public static final int ATTACHMENT_TYPE_DOCUMENT

Value of 3: indicating the attachment is the document type.

See Also:

Constant Field Values

ATTACHMENT_TYPE_STORED_SEARCH

public static final int ATTACHMENT_TYPE_STORED_SEARCH

Value of 4: indicating the attachment is the stored search type.

See Also:

Constant Field Values

ATTACHMENT_TYPE_URL

public static final int ATTACHMENT_TYPE_URL

Value of 5: indicating the attachment type is a UNC or URL.

See Also:

Constant Field Values

ATTACHMENT_TYPE_CUSTOM_OBJECT

public static final int ATTACHMENT_TYPE_CUSTOM_OBJECT

Value of 6: indicating the attachment type is a Custom object.

See Also:

Constant Field Values

ATTACHMENT_TYPE_TASK

public static final int ATTACHMENT_TYPE_TASK

Value of 7: indicating the attachment type is a Task object.

Since:

CPE 5.2.0.3 IF003

See Also:

Constant Field Values

Constructor Detail

VWAttachmentType

public VWAttachmentType()

Method Detail

getLocalizedString

public static java.lang.String getLocalizedString(int theAttachmentType)
                                           throws VWException

Gets a localized string associated with a valid attachment type integer value.

Parameters:

theAttachmentType - A value associated with the localizable description string for the attachment type

Returns:

The localized description for the attachment type

Throws:

VWException - Thrown if the theAttachmentType parameter value is invalid

See Also:

VWAttachmentType.isValid(int)

isValid

public static boolean isValid(int theAttachmentType)

Validates whether the input value is a valid attachment type.

Parameters:

theAttachmentType - A value to validate as an attachment type

Returns:

A boolean value: true if the theAttachmentType input parameter is a valid attachment type; false otherwise