com.bigllc.retsiq.simpleclient
Enum RETSUserSession.MetadataLevel

java.lang.Object
  java.lang.Enum<RETSUserSession.MetadataLevel>
      com.bigllc.retsiq.simpleclient.RETSUserSession.MetadataLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RETSUserSession.MetadataLevel>

Enclosing class:

RETSUserSession

public static enum RETSUserSession.MetadataLevel
extends java.lang.Enum<RETSUserSession.MetadataLevel>

Enumerated type for determining the level of metadata to load.

Enum Constant Summary

ALL
All the metadata.

IGNORE_UPDATE
Ignore any metadata related to the update transaction/.

SYSTEM
Just get the system metadata

Method Summary

static RETSUserSession.MetadataLevel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RETSUserSession.MetadataLevel[]	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

SYSTEM

public static final RETSUserSession.MetadataLevel SYSTEM

Just get the system metadata

IGNORE_UPDATE

public static final RETSUserSession.MetadataLevel IGNORE_UPDATE

Ignore any metadata related to the update transaction/.

ALL

public static final RETSUserSession.MetadataLevel ALL

All the metadata.

Method Detail

values

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

Returns:

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

valueOf

public static RETSUserSession.MetadataLevel valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null