Package ch.sahits.game.openpatrician.model.people

Interface IPatrol

All Superinterfaces:

IPerson, ISideRoomPerson, ITavernPerson

All Known Implementing Classes:

PatrolState

public interface IPatrol
extends ISideRoomPerson

Trader who wishes to order a patrol along three cities.

Author:

Andi Hotz, (c) Sahits GmbH, 2013 Created on Jan 26, 2013

Method Summary

Modifier and Type	Method	Description
int	getBonus()	Retrieve the bonus for each destroyed ship.
int	getCurrentDestIndex()	Retrieve the current index in the destination list.
ICity[]	getDestinations()	Retrieve the destinations
java.lang.String	getName()	Get the name of the client.
int	getPremium()	Retrieve the premium for successful finishing the patrol.
void	setBonus(int bonus)	Define the premium
void	setCurrentDestIndex(int index)	Set the current index in the destination list.
void	setDestinations(ICity[] cities)	Set the destination city of the patrol.
void	setName(java.lang.String name)	Set the name of the client.
void	setPremium(int premium)	Set the premium for task completion.

Methods inherited from interface ch.sahits.game.openpatrician.model.people.ITavernPerson

arrive, getArrivalDate, getMaxDaysAbsent, getMaxDaysPresent, getNumberOfDaysSinceArrival, isPresent, isPresentProperty, leave, setCity

Method Detail

getBonus

int getBonus()

Retrieve the bonus for each destroyed ship.

Returns:

premium to be payed on successful patrol completion

setBonus

void setBonus(int bonus)

Define the premium

Parameters:

bonus - to be payed after completion.

getName

java.lang.String getName()

Get the name of the client.

Returns:

name of the person

setName

void setName(java.lang.String name)

Set the name of the client.

Parameters:

name - of the client

getDestinations

ICity[] getDestinations()

Retrieve the destinations

Returns:

array of destination cities.

setDestinations

void setDestinations(ICity[] cities)

Set the destination city of the patrol.

Parameters:

cities - array of destination cities.

getPremium

int getPremium()

Retrieve the premium for successful finishing the patrol.

Returns:

premium for completing the patrol

setPremium

void setPremium(int premium)

Set the premium for task completion.

Parameters:

premium - for completing the patrol

setCurrentDestIndex

void setCurrentDestIndex(int index)

Set the current index in the destination list.

Parameters:

index - current index of the destination

getCurrentDestIndex

int getCurrentDestIndex()

Retrieve the current index in the destination list.

Returns:

current index of the destination.