Renamed 'ship-simu' to 'shipsimu' + added 'core' and symlink to core/inc

[shipsimu.git] / application / shipsimu / interfaces / class_Customer.php

diff --git a/application/shipsimu/interfaces/class_Customer.php b/application/shipsimu/interfaces/class_Customer.php
new file mode 100644 (file)
index 0000000..5de5210
--- /dev/null
+++ b/application/shipsimu/interfaces/class_Customer.php
@@ -0,0 +1,55 @@
+<?php
+/**
+ * An interface for all customers
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.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.shipsimu.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
+        * @return      void
+        */
+       function addNewWorksContract (SignableContract $contractInstance);
+
+       /**
+        * Signs a works contract.
+        *
+        * @param       $contractInstance       A valid instance to WorksContract
+        * @param       $partnerInstance        An instance the other contract partner
+        * @return      void
+        * @throws      InvalidContractPartnerException         If the in $contractInstance
+        *                                                                              set contract partner is
+        *                                                                              not the expected
+        */
+       function signContract (SignableContract $contractInstance, ContractPartner $partnerInstance);
+
+       /**
+        * Withdraw from a signed contract
+        *
+        * @param       $contractInstance       A valid instance to WorksContract
+        * @return      void
+        */
+       function withdrawFromContract (SignableContract $contractInstance);
+}
+
+// [EOF]
+?>