org.marketcetera.ors
Enum ReportCache

java.lang.Object
  java.lang.Enum<ReportCache>
      org.marketcetera.ors.ReportCache

All Implemented Interfaces:

Serializable, Comparable<ReportCache>

public enum ReportCache
extends Enum<ReportCache>

Caches latest report by OrderID.

Since:

2.1.4

Version:

$Id: ReportCache.java 16154 2012-07-14 16:34:05Z colin $

Author:

Colin DuPlantis

Enum Constant Summary

INSTANCE

Method Summary

void	cache(ExecutionReport inReport) Caches the given ExecutionReport value.
void	clear() Clears the ExecutionReport cache.
ExecutionReport	getLatestReportFor(String inOrderId) Gets the latest ExecutionReport for the given order ID value.
static ReportCache	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReportCache[]	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

INSTANCE

public static final ReportCache INSTANCE

Method Detail

values

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

Returns:

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

valueOf

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

getLatestReportFor

public ExecutionReport getLatestReportFor(String inOrderId)

Gets the latest ExecutionReport for the given order ID value.

Parameters:

inOrderId - a String value

Returns:

an ExecutionReport value or null

cache

public void cache(ExecutionReport inReport)

Caches the given ExecutionReport value.

Parameters:

inReport - an ExecutionReport value

clear

public void clear()

Clears the ExecutionReport cache.