Copyright updated, menu class added for 'home'
[shipsimu.git] / application / ship-simu / interfaces / class_Customer.php
index a49150e410faf0214fe7a2d4be3bf32b6dbdb292..d9cedec380f9d7a47e4fc4c0b53f63aaa2e38cd2 100644 (file)
@@ -2,44 +2,53 @@
 /**
  * An interface for all customers
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 interface Customer extends FrameworkInterface {
        /**
         * Adds a contract to the customer's list
         *
-        * @param               $contractInstance       A valid instance to WorksContract
+        * @param       $contractInstance       A valid instance to WorksContract
         * @return      void
         */
-       function addNewWorksContract (WorksContract $contractInstance);
+       function addNewWorksContract (SignableContract $contractInstance);
 
        /**
         * Signs a works contract.
         *
-        * @param               $contractInstance                               A valid instance to WorksContract
-        * @param               $partnerInstance                                An instance the other
-        *                                                                              contract partner
+        * @param       $contractInstance       A valid instance to WorksContract
+        * @param       $partnerInstance        An instance the other contract partner
         * @return      void
-        * @throws      NullPointerException                    If an instance variable
-        *                                                                              is null
-        * @throws      NoObjectException                               If an instance variable
-        *                                                                              is not an object
-        * @throws      MissingMethodException                  If a required method was
-        *                                                                              not found in $contractInstance
-        * @throws      InvalidContractPartnerException If the in $contractInstance
+        * @throws      InvalidContractPartnerException         If the in $contractInstance
         *                                                                              set contract partner is
         *                                                                              not the expected
         */
-       function signContract (WorksContract $contractInstance, ContractPartner $partnerInstance);
+       function signContract (SignableContract $contractInstance, ContractPartner $partnerInstance);
 
        /**
         * Withdraw from a signed contract
         *
-        * @param               $contractInstance       A valid instance to WorksContract
+        * @param       $contractInstance       A valid instance to WorksContract
         * @return      void
         */
-       function withdrawFromContract (WorksContract $contractInstance);
+       function withdrawFromContract (SignableContract $contractInstance);
 }
 
 // [EOF]