(no commit message)

[shipsimu.git] / inc / classes / interfaces / extended / class_LimitableObject.php

diff --git a/inc/classes/interfaces/extended/class_LimitableObject.php b/inc/classes/interfaces/extended/class_LimitableObject.php
new file mode 100644 (file)
index 0000000..8ed5eb9
--- /dev/null
+++ b/inc/classes/interfaces/extended/class_LimitableObject.php
@@ -0,0 +1,39 @@
+<?php
+/**
+ * This is an inface for limiting object while saving them with the
+ * DatabaseConnection class.
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * 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 LimitableObject extends FrameworkInterface {
+       /**
+        * Reduces the volume of a processed object.
+        *
+        * @param               $limitInstance          An instance to ObjectLimits which holds
+        *                                                      attribute names that we want to include
+        *                                                      in the processing phase. Other attributes
+        *                                                      except $uniqueID and $realClass will be
+        *                                                      ignored and keept out.
+        * @return      void
+        */
+       function limitObject (ObjectLimits $limitInstance);
+}
+
+// [EOF]
+?>