Package net.sf.freecol.server.model

Class NativeTradeSession

java.lang.Object

net.sf.freecol.server.model.Session

net.sf.freecol.server.model.NativeTradeSession

public class NativeTradeSession
extends Session

A type of session to handle trading with a native settlement.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.logging.Logger	logger
private int	movesLeft	The moves the trading unit has left at start of session.
private NativeTrade	nt	The native trade information.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NativeTradeSession(NativeTrade nt)	Creates a new NativeTradeSession.

Method Summary

Modifier and Type	Method	Description
boolean	complete(ChangeSet cs)	All transaction types must implement a completion action.
NativeTrade	getNativeTrade()	Get the native trade underway.
static NativeTrade	openSession(NativeTrade nt)	Helper function to update a tentative native trade and open a session for it.
java.lang.String	toString()

Methods inherited from class net.sf.freecol.server.model.Session

clearAll, completeAll, findSession, getKey, lookup, lookup, lookup, makeSessionKey, makeSessionKey, register

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logger

private static final java.util.logging.Logger logger

movesLeft

private final int movesLeft

The moves the trading unit has left at start of session.

nt

private NativeTrade nt

The native trade information.

Constructor Detail

NativeTradeSession

private NativeTradeSession(NativeTrade nt)

Creates a new NativeTradeSession.

Parameters:

nt - The NativeTrade

Method Detail

getNativeTrade

public NativeTrade getNativeTrade()

Get the native trade underway.

Returns:

The NativeTrade.

openSession

public static NativeTrade openSession(NativeTrade nt)

Helper function to update a tentative native trade and open a session for it.

Parameters:

nt - The proposed NativeTrade.

Returns:

The updated NativeTrade.

complete

public boolean complete(ChangeSet cs)

All transaction types must implement a completion action. This is called by the controller at the end of turn to complete any sessions that have not yet completed, or if the controller gets the required response to complete the session.

Overrides:

complete in class Session

Parameters:

cs - A ChangeSet to update with changes that occur when completing this session.

Returns:

True if the session was already complete.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object