1 | <?php |
||
7 | final class SearchQuery implements QueryInterface |
||
8 | { |
||
9 | /** |
||
10 | * @info KvK number, identifying number for a registration in the Netherlands Business Register. Consists of 8 digits |
||
11 | * @var string |
||
12 | */ |
||
13 | private $kvkNumber; |
||
14 | |||
15 | /** |
||
16 | * @info Branch number (Vestigingsnummer), identifying number of a branch. Consists of 12 digits |
||
17 | * @var string |
||
18 | */ |
||
19 | private $branchNumber; |
||
20 | |||
21 | /** |
||
22 | * @info RSIN is an identification number for legal entities and partnerships. Consist of only digits |
||
23 | * @var int |
||
24 | */ |
||
25 | private $rsin; |
||
26 | |||
27 | /** |
||
28 | * @info Street of an address |
||
29 | * @var string |
||
30 | */ |
||
31 | private $street; |
||
32 | |||
33 | /** |
||
34 | * @info House number of an address |
||
35 | * @var string |
||
36 | */ |
||
37 | private $houseNumber; |
||
38 | |||
39 | /** |
||
40 | * @info Postal code or ZIP code, example 1000AA |
||
41 | * @var string |
||
42 | */ |
||
43 | private $postalCode; |
||
44 | |||
45 | /** |
||
46 | * @info City or Town name |
||
47 | * @var string |
||
48 | */ |
||
49 | private $city; |
||
50 | |||
51 | /** |
||
52 | * @info Indication to include searching through inactive dossiers/deregistered companies. |
||
53 | * @note History of inactive companies is after 1 January 2012 |
||
54 | * @var bool |
||
55 | */ |
||
56 | private $includeInactiveRegistrations; |
||
57 | |||
58 | /** |
||
59 | * @info restrictToMainBranch Search is restricted to main branches. |
||
60 | * @var bool |
||
61 | */ |
||
62 | private $restrictToMainBranch; |
||
63 | |||
64 | /** |
||
65 | * @info Defines the search collection for the query |
||
66 | * @var string |
||
67 | */ |
||
68 | private $site; |
||
69 | |||
70 | /** |
||
71 | * @info User can optionally add a context to identify his result later on |
||
72 | * @var string |
||
73 | */ |
||
74 | private $context; |
||
75 | |||
76 | /** |
||
77 | * @info Free format text search for in the compiled search description. |
||
78 | * @var string |
||
79 | */ |
||
80 | private $q; |
||
81 | |||
82 | public function getStreet(): string |
||
86 | |||
87 | public function setStreet(string $street): void |
||
91 | |||
92 | public function getHouseNumber(): string |
||
96 | |||
97 | public function setHouseNumber(string $houseNumber): void |
||
101 | |||
102 | public function getKvkNumber(): string |
||
106 | |||
107 | public function setKvkNumber(string $kvkNumber): void |
||
111 | |||
112 | public function getBranchNumber(): string |
||
116 | |||
117 | public function setBranchNumber(string $branchNumber): void |
||
121 | |||
122 | public function getRsin(): int |
||
126 | |||
127 | public function setRsin(int $rsin): void |
||
131 | |||
132 | public function getPostalCode(): string |
||
136 | |||
137 | public function setPostalCode(string $postalCode): void |
||
141 | |||
142 | public function getCity(): string |
||
146 | |||
147 | public function setCity(string $city): void |
||
151 | |||
152 | public function isIncludeInactiveRegistrations(): bool |
||
156 | |||
157 | public function setIncludeInactiveRegistrations(bool $includeInactiveRegistrations): void |
||
161 | |||
162 | public function isRestrictToMainBranch(): bool |
||
166 | |||
167 | public function setRestrictToMainBranch(bool $restrictToMainBranch): void |
||
171 | |||
172 | public function getSite(): string |
||
176 | |||
177 | public function setSite(string $site): void |
||
181 | |||
182 | public function getContext(): string |
||
186 | |||
187 | public function setContext(string $context): void |
||
191 | |||
192 | public function getQ(): string |
||
196 | |||
197 | public function setQ(string $q): void |
||
201 | |||
202 | public function get(): array |
||
206 | } |
||
207 |