org.eclipse.stardust.engine.api.query

Enum BusinessObjectQuery.Option

java.lang.Object

java.lang.Enum<BusinessObjectQuery.Option>

org.eclipse.stardust.engine.api.query.BusinessObjectQuery.Option

All Implemented Interfaces:

Serializable, Comparable<BusinessObjectQuery.Option>

Enclosing class:

BusinessObjectQuery

public static enum BusinessObjectQuery.Option
extends Enum<BusinessObjectQuery.Option>

Policy options.

Version:

$Revision: $

Author:

Florin.Herinean

Enum Constant Summary

Enum Constants

Enum Constant and Description
UPGRADE Result includes only the last business object instance values eventually upgraded to current schema.
WITH_DESCRIPTION Result includes business object description.
WITH_VALUES Result includes business object instance values.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WITH_DESCRIPTION

public static final BusinessObjectQuery.Option WITH_DESCRIPTION

Result includes business object description.

WITH_VALUES

public static final BusinessObjectQuery.Option WITH_VALUES

Result includes business object instance values.

UPGRADE

public static final BusinessObjectQuery.Option UPGRADE

Result includes only the last business object instance values eventually upgraded to current schema.

Method Detail

values

public static BusinessObjectQuery.Option[] 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 (BusinessObjectQuery.Option c : BusinessObjectQuery.Option.values())
    System.out.println(c);

Returns:

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

valueOf

public static BusinessObjectQuery.Option 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