com.caplin.motif.fx.ret.common.instrument

Interface InstrumentProvider

All Known Implementing Classes:

FxCrossInstrumentProvider

public interface InstrumentProvider

An interface for querying the instrument for a RET user and currency pair.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InstrumentProvider.Context

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInstrument(java.lang.String ssoUsername, java.lang.String toboUsername) Returns the instrument for the given ssoUsername.
void	initialise(InstrumentProvider.Context context) This notifies the InstrumentProvider that it is about to be loaded.

Method Detail

initialise

void initialise(InstrumentProvider.Context context)

This notifies the InstrumentProvider that it is about to be loaded. This method will be called by the system once.

You should use this method to perform any initialisation required before the InstrumentProvider is loaded by the system.

getInstrument

java.lang.String getInstrument(java.lang.String ssoUsername,
                               java.lang.String toboUsername)
                        throws InstrumentNotFoundException

Returns the instrument for the given ssoUsername.

Use this method to determine which instrument should be returned.

Throws:

InstrumentNotFoundException