Caplin Systems - PricingSide (FX Integration API Documentation)

java.lang.Object
- java.lang.Enum<PricingSide>
- - com.caplin.motif.fx.trading.PricingSide

All Implemented Interfaces:

Serializable, Comparable<PricingSide>
```
public enum PricingSide
extends Enum<PricingSide>
```
The pricing side as requested by the frontend.

Generally for RFS trades, the frontend will wish to see a two way price. If they are not permissioned or opt to choose a side before they request a price, this enum will indicate the side that was requested.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`BUY`	The client wishes to receive an ASK price only as they are interested in buying.
`SELL`	The client wishes to receive a BID price only as they are interested in selling.
`TWO_WAY`	The client is interested in seeing both sides of the quote.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static PricingSide`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static PricingSide[]`	`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
  - BUY
```
public static final PricingSide BUY
```
    The client wishes to receive an ASK price only as they are interested in buying.
  - SELL
```
public static final PricingSide SELL
```
    The client wishes to receive a BID price only as they are interested in selling.
  - TWO_WAY
```
public static final PricingSide TWO_WAY
```
    The client is interested in seeing both sides of the quote.
- Method Detail
  - values
```
public static PricingSide[] 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 (PricingSide c : PricingSide.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PricingSide 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