IShipyard (OpenPatricianModel 0.9.0-RC1 API)

All Known Implementing Classes:

ShipyardState
```
public interface IShipyard
```
Interface defining the model of the ship yard.

Author:

Andi Hotz, (c) Sahits GmbH, 2013 Created on Mar 9, 2013

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addShipBuildingOrder(IShipDueDate dueDate, Optional<TimedTask> task)` Add an order for building a new ship to the list.
`void`	`addShipRefitOrder(IShipDueDate dueDate, Optional<TimedTask> task)` Add an order for refitting a ship to the list.
`void`	`addShipRepairOrder(IShipDueDate dueDate, Optional<TimedTask> task)` Add an order for repairing a ship to the list.
`int`	`calculateBuildTime(EShipType type)` Calculate the build time for the ship of type.
`int`	`calculateConstructionCosts(EShipType type)` Calculate the labor costs for building a new ship of the indicated type.
`int`	`calculateRefitCosts(EShipType type, int levels)` Calculate the labor costs for the refit based on the ship type and how many levels should be upgraded.
`int`	`calculateRefitTime(EShipType type)` Calculate the time in days it takes for refitting.
`int`	`calculateRepairCosts(int repairTime, int materialCosts)` Calculate the repair costs.
`int`	`calculateRepairMaterialCosts(IShip ship, int damage)` Calculate the material costs for the repair.
`int`	`calculateRepairTime(EShipType type)` Calculate the repair time for the ship of type.
`void`	`cancelRepair(IShip ship)` Cancel the repair of the ship.
`void`	`cancelShipBuildingOrder(java.time.LocalDateTime finish)` Cancel the order of the building, finished on the given date.
`EShipType[]`	`getBuildableShipTypes()` Retrieve a list of all the types of ships this yard can build.
`java.time.LocalDateTime`	`getBuildCompleteDate(EShipType type)` Retrieve the date when the building of a new ship will be finished.
`ICity`	`getCity()` Retrieve the city the shipyard belongs to.
`List<IShipDueDate>`	`getShipBuildingList()` Retrieve an immutable list of the ships that are ordered to be built on this shipyard.
`List<IShipDueDate>`	`getShipRepairList()` Retrieve the list of all ships that are to be repaired.
`List<IShipDueDate>`	`getShipUpgradeList()` Retrieve the list of all ships that are to be upgraded.
`void`	`removeCompletedConstruction(IShip ship)` Remove the build entry once it is completed.
`void`	`removeCompletedRepair(IShip ship)` Remove the repair entry once it is completed.
`void`	`removeCompletedUpgrade(IShip ship)` Remove the upgrade entry once it is completed.

- Method Detail
  - getCity
```
ICity getCity()
```
    Retrieve the city the shipyard belongs to.
    
    Returns:
  - getShipBuildingList
```
List<IShipDueDate> getShipBuildingList()
```
    Retrieve an immutable list of the ships that are ordered to be built on this shipyard.
    
    Returns:
    
    immutable list of ship due dates.
  - getBuildCompleteDate
```
java.time.LocalDateTime getBuildCompleteDate(EShipType type)
```
    Retrieve the date when the building of a new ship will be finished.
    
    Parameters:
    
    type - of the ship to be built
    
    Returns:
    
    end date of the building
  - addShipBuildingOrder
```
void addShipBuildingOrder(IShipDueDate dueDate,
                          Optional<TimedTask> task)
```
    Add an order for building a new ship to the list.
    
    Parameters:
    
    dueDate - when the ship is finished building
    
    task - that is executed on completion.
  - addShipRepairOrder
```
void addShipRepairOrder(IShipDueDate dueDate,
                        Optional<TimedTask> task)
```
    Add an order for repairing a ship to the list.
    
    Parameters:
    
    dueDate - when the ship is finished repairing
    
    task - that is executed on completion.
  - addShipRefitOrder
```
void addShipRefitOrder(IShipDueDate dueDate,
                       Optional<TimedTask> task)
```
    Add an order for refitting a ship to the list.
    
    Parameters:
    
    dueDate - when the ship is refitted
    
    task - that is executed on completion.
  - cancelShipBuildingOrder
```
void cancelShipBuildingOrder(java.time.LocalDateTime finish)
```
    Cancel the order of the building, finished on the given date.
    
    Parameters:
    
    finish - date
  - getShipRepairList
```
List<IShipDueDate> getShipRepairList()
```
    Retrieve the list of all ships that are to be repaired.
    
    Returns:
    
    immutable list of all the repairing ships
  - getShipUpgradeList
```
List<IShipDueDate> getShipUpgradeList()
```
    Retrieve the list of all ships that are to be upgraded.
    
    Returns:
    
    immutable list of all the upgrading ships
  - cancelRepair
```
void cancelRepair(IShip ship)
```
    Cancel the repair of the ship. No damage will be repaired
    
    Parameters:
    
    ship - which's repair order is to be canceled
  - calculateRepairCosts
```
int calculateRepairCosts(int repairTime,
                         int materialCosts)
```
    Calculate the repair costs.
    
    Parameters:
    
    repairTime -
    
    materialCosts -
    
    Returns:
  - calculateRepairMaterialCosts
```
int calculateRepairMaterialCosts(IShip ship,
                                 int damage)
```
    Calculate the material costs for the repair.
    
    Parameters:
    
    ship -
    
    damage -
    
    Returns:
  - calculateRefitCosts
```
int calculateRefitCosts(EShipType type,
                        int levels)
```
    Calculate the labor costs for the refit based on the ship type and how many levels should be upgraded.
    
    Parameters:
    
    type -
    
    levels -
    
    Returns:
  - calculateRefitTime
```
int calculateRefitTime(EShipType type)
```
    Calculate the time in days it takes for refitting.
    
    Parameters:
    
    type - destination level
    
    Returns:
    
    time in days.
  - getBuildableShipTypes
```
EShipType[] getBuildableShipTypes()
```
    Retrieve a list of all the types of ships this yard can build.
    
    Returns:
  - calculateConstructionCosts
```
int calculateConstructionCosts(EShipType type)
```
    Calculate the labor costs for building a new ship of the indicated type.
    
    Parameters:
    
    type - of the ship
    
    Returns:
    
    costs.
  - calculateBuildTime
```
int calculateBuildTime(EShipType type)
```
    Calculate the build time for the ship of type.
    
    Parameters:
    
    type -
    
    Returns:
  - calculateRepairTime
```
int calculateRepairTime(EShipType type)
```
    Calculate the repair time for the ship of type.
    
    Parameters:
    
    type -
    
    Returns:
  - removeCompletedRepair
```
void removeCompletedRepair(IShip ship)
```
    Remove the repair entry once it is completed.
    
    Parameters:
    
    ship - that is to be repaired.
  - removeCompletedConstruction
```
void removeCompletedConstruction(IShip ship)
```
    Remove the build entry once it is completed.
    
    Parameters:
    
    ship - that is to be built.
  - removeCompletedUpgrade
```
void removeCompletedUpgrade(IShip ship)
```
    Remove the upgrade entry once it is completed.
    
    Parameters:
    
    ship - that is to be upgraded.

Interface IShipyard

Method Summary

Method Detail

getCity

getShipBuildingList

getBuildCompleteDate

addShipBuildingOrder

addShipRepairOrder

addShipRefitOrder

cancelShipBuildingOrder

getShipRepairList

getShipUpgradeList

cancelRepair

calculateRepairCosts

calculateRepairMaterialCosts

calculateRefitCosts

calculateRefitTime

getBuildableShipTypes

calculateConstructionCosts

calculateBuildTime

calculateRepairTime

removeCompletedRepair

removeCompletedConstruction

removeCompletedUpgrade