application/ship-simu/interfaces/class_Customer.php

   1 <?php
   2 /**
   3  * An interface for all customers
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface Customer extends FrameworkInterface {
  25         /**
  26          * Adds a contract to the customer's list
  27          *
  28          * @param       $contractInstance       A valid instance to WorksContract
  29          * @return      void
  30          */
  31         function addNewWorksContract (SignableContract $contractInstance);
  32
  33         /**
  34          * Signs a works contract.
  35          *
  36          * @param       $contractInstance       A valid instance to WorksContract
  37          * @param       $partnerInstance        An instance the other contract partner
  38          * @return      void
  39          * @throws      InvalidContractPartnerException         If the in $contractInstance
  40          *                                                                              set contract partner is
  41          *                                                                              not the expected
  42          */
  43         function signContract (SignableContract $contractInstance, ContractPartner $partnerInstance);
  44
  45         /**
  46          * Withdraw from a signed contract
  47          *
  48          * @param       $contractInstance       A valid instance to WorksContract
  49          * @return      void
  50          */
  51         function withdrawFromContract (SignableContract $contractInstance);
  52 }
  53
  54 // [EOF]
  55 ?>