Caplin Systems - RegulatoryID (FX Integration API Documentation)

java.lang.Object
- com.caplin.motif.fx.trading.allocation.RegulatoryID

```
public class RegulatoryID
extends Object
```
Some systems provide a regulatory ID that is associated with an allocation.
For swap allocations there may be two regulatory id's, a near regulatory ID and a far regulatory ID.

Field Summary

Fields
Modifier and Type Field Description

static String FAR_REGULATORY_ID

static String NEAR_REGULATORY_ID

Constructor Summary

Constructors
Constructor	Description
`RegulatoryID(PostTradeAllocation postTradeAllocation, String nearRegulatoryId, String farRegulatoryId)`	Constructs a Regulatory ID using a PostTradeAllocation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

Map<String,String> getFields()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NEAR_REGULATORY_ID
```
public static final String NEAR_REGULATORY_ID
```
    See Also:
    
    Constant Field Values
  - FAR_REGULATORY_ID
```
public static final String FAR_REGULATORY_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RegulatoryID
```
public RegulatoryID(PostTradeAllocation postTradeAllocation,
                    String nearRegulatoryId,
                    String farRegulatoryId)
```
    Constructs a Regulatory ID using a PostTradeAllocation.
    
    For a SPOT or FORWARD allocation provide a nearRegulatoryId and null for farRegulatoryId
    
    For a SWAP allocation provide both a nearRegulatoryId and farRegulatoryId
    
    Parameters:
    
    postTradeAllocation - The post trade allocation that has been allocated
    
    nearRegulatoryId - The regulatory Id of the allocation
    
    farRegulatoryId - An additional regulatory id for a far leg, if the allocation was a SWAP
- Method Detail
  - getFields
```
public Map<String,String> getFields()
```