3 namespace Org\Mxchange\CoreFramework\Criteria\Update;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Criteria\BaseCriteria;
7 use Org\Mxchange\CoreFramework\Criteria\Local\LocalSearchCriteria;
8 use Org\Mxchange\CoreFramework\Criteria\Local\LocalUpdateCriteria;
11 * Search criteria for e.g. searching in databases. Do not use this class if
12 * you are looking for a ship or company, or what ever. Instead use this class
13 * for looking in storages like the database.
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 Core Developer Team
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.shipsimu.org
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 class UpdateCriteria extends BaseCriteria implements LocalUpdateCriteria {
36 * Search criteria instance
38 private $searchInstance = NULL;
41 * Protected constructor
45 private function __construct () {
46 // Call parent constructor
47 parent::__construct(__CLASS__);
51 * Create an instance of this class
53 * @return $criteriaInstance An instance of this criteria
55 public static final function createUpdateCriteria () {
57 $criteriaInstance = new UpdateCriteria();
59 // Return this instance
60 return $criteriaInstance;
64 * Getter for update criteria array
66 * @return $updateCriteria Array holding the update criteria
68 public final function getUpdateCriteria () {
69 return $this->getCriteriaArray();
73 * Setter for search instance
75 * @param $searchInstance Searchable criteria instance
78 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
79 $this->searchInstance = $searchInstance;
83 * Getter for search instance
85 * @return $searchInstance Searchable criteria instance
87 public final function getSearchInstance () {
88 return $this->searchInstance;