com.bea.alcs.service.search
Enum IndexType

java.lang.Object
  java.lang.Enum<IndexType>
      com.bea.alcs.service.search.IndexType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IndexType>

public enum IndexType
extends java.lang.Enum<IndexType>

An enumeration of the search index types EP uses.

Enum Constant Summary

CATEGORY
A category index type.

CUSTOMER
A customer index type.

ORDER
An order index type.

ORDER_RETURN
An order return index type.

PRODUCT
A product index type.

PRODUCT_ASSOCIATION
A product association index type.

PROMOTION
A promotion index type.

Method Summary

static IndexType	findFromName(java.lang.String indexName) Attempts to find the IndexType with the given name.
java.lang.String	getIndexName() Return a string identifier for this type in lower case.
static IndexType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IndexType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PRODUCT

public static final IndexType PRODUCT

A product index type.

PRODUCT_ASSOCIATION

public static final IndexType PRODUCT_ASSOCIATION

A product association index type.

CATEGORY

public static final IndexType CATEGORY

A category index type.

CUSTOMER

public static final IndexType CUSTOMER

A customer index type.

ORDER

public static final IndexType ORDER

An order index type.

ORDER_RETURN

public static final IndexType ORDER_RETURN

An order return index type.

PROMOTION

public static final IndexType PROMOTION

A promotion index type.

Method Detail

values

public static final IndexType[] values()

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

for(IndexType c : IndexType.values())
        System.out.println(c);

Returns:

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

valueOf

public static IndexType 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

getIndexName

public java.lang.String getIndexName()

Return a string identifier for this type in lower case.

Returns:

a lower case identifier for this index type.

findFromName

public static IndexType findFromName(java.lang.String indexName)

Attempts to find the IndexType with the given name. Returns null if the type is not found.

Parameters:

indexName - the index name to search for

Returns:

a IndexType with the given name