com.hcl.domino.richtext.structures

Enum AssistStruct.Search

java.lang.Object

java.lang.Enum<AssistStruct.Search>

com.hcl.domino.richtext.structures.AssistStruct.Search

All Implemented Interfaces:

INumberEnum<Short>, Serializable, Comparable<AssistStruct.Search>

Enclosing interface:

AssistStruct

public static enum AssistStruct.Search
extends Enum<AssistStruct.Search>
implements INumberEnum<Short>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL All documents in database
MODIFIED New or modified docs since last run
NEW New documents since last run
NONE Unknown or unavailable
PROMPT Prompt user
SELECTED Selected documents
UI Works on the selectable object
UNREAD All unread documents
VIEW All documents in view

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Short	getValue()
static AssistStruct.Search	valueOf(String name) Returns the enum constant of this type with the specified name.
static AssistStruct.Search[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final AssistStruct.Search NONE

Unknown or unavailable

ALL

public static final AssistStruct.Search ALL

All documents in database

NEW

public static final AssistStruct.Search NEW

New documents since last run

MODIFIED

public static final AssistStruct.Search MODIFIED

New or modified docs since last run

SELECTED

public static final AssistStruct.Search SELECTED

Selected documents

VIEW

public static final AssistStruct.Search VIEW

All documents in view

UNREAD

public static final AssistStruct.Search UNREAD

All unread documents

PROMPT

public static final AssistStruct.Search PROMPT

Prompt user

UI

public static final AssistStruct.Search UI

Works on the selectable object

Method Detail

values

public static AssistStruct.Search[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AssistStruct.Search c : AssistStruct.Search.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AssistStruct.Search valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public Short getValue()

Specified by:

getValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum as a long