1 <?php
  2 
  3 namespace rpf\api\module;
  4 use rpf\api\apiModule;
  5 use rpf\system\module\exception;
  6 
  7 /**
  8  * Implementation of bbOrder::readEntry
  9  *
 10  * @package system\module
 11  */
 12 class bbOrder_readEntry extends apiModule
 13 {
 14     protected $rpcMethod = 'bbOrder::readEntry';
 15 
 16     /**
 17      * Set primary-key on customerId
 18      *
 19      * @param $ceid
 20      * @return $this
 21      */
 22     public function setCeid($ceid)
 23     {
 24         return $this->addParam('ceid', (integer) $ceid);
 25     }
 26 
 27     /**
 28      * Set primary-key on customerId
 29      *
 30      * @param $ceid
 31      * @return $this
 32      */
 33     public function setCustomerId($ceid)
 34     {
 35         return $this->setCeid((integer) $ceid);
 36     }
 37 
 38     /**
 39      * Set primary-key on orderId
 40      *
 41      * @param $oeid
 42      * @return $this
 43      */
 44     public function setOeid($oeid)
 45     {
 46         return $this->addParam('oeid', (integer) $oeid);
 47     }
 48 
 49     /**
 50      * Set primary-key on orderId
 51      *
 52      * @param $oeid
 53      * @return $this
 54      */
 55     public function setOrderId($oeid)
 56     {
 57         return $this->setOeid((integer)$oeid);
 58     }
 59 
 60     /**
 61      * Set primary-key on orderNumber
 62      *
 63      * @param $ordnr
 64      * @return $this
 65      */
 66     public function setOrdnr($ordnr)
 67     {
 68         return $this->addParam('ordnr', (string) $ordnr);
 69     }
 70 
 71     /**
 72      * Set primary-key on orderNumber
 73      *
 74      * @param $ordnr
 75      * @return $this
 76      */
 77     public function setOrderNumber($ordnr)
 78     {
 79         return $this->setOrdnr((integer) $ordnr);
 80     }
 81 
 82     /**
 83      * Set primary-key on not released orders
 84      *
 85      * @param $unfree
 86      * @return $this
 87      */
 88     public function setUnfree($unfree)
 89     {
 90         return $this->addParam('return_unfree', (bool) $unfree);
 91     }
 92 
 93     /**
 94      * Set primary-key onid of agreement
 95      *
 96      * @param $scale
 97      * @return $this
 98      */
 99     public function setScale($scale)
100     {
101         return $this->addParam('scale', (integer) $scale);
102     }
103 
104     /**
105      * Set primary-key on not released orders
106      *
107      * @param $view
108      * @return $this
109      */
110     public function setView($view)
111     {
112         return $this->addParam('view', (string) $view);
113     }
114 
115 
116     /**
117      * Return all bills
118      *
119      * @param $bool
120      * @return $this
121      */
122     public function addReturnAccountEntries($bool = true)
123     {
124         return $this->addParam('return_account_entrys', (bool) $bool);
125     }
126 
127     /**
128      * Return all bookings
129      *
130      * @param $bool
131      * @return $this
132      */
133     public function addReturnSettlements($bool = true)
134     {
135         $this->addReturnAccountEntries();
136         return $this->addParam('return_settlements', (bool) $bool);
137     }
138 
139 
140     /**
141      * Return all dispositions
142      *
143      * @param $bool
144      * @return $this
145      */
146     public function addReturnDispositions($bool = true)
147     {
148         return $this->addParam('return_dispositions', (bool) $bool);
149     }
150 
151     /**
152      * Return all active dispositions
153      *
154      * @param $bool
155      * @return $this
156      */
157     public function addReturnActiveDispositions($bool = true)
158     {
159         $this->addReturnDispositions();
160         return $this->addParam('return_active', (bool) $bool);
161     }
162 
163     /**
164      * Return all disposition prices
165      *
166      * @param $bool
167      * @return $this
168      */
169     public function addReturnDispositionPrices($bool = true)
170     {
171         $this->addReturnDispositions();
172         return $this->addParam('return_disposition_prices', (bool) $bool);
173     }
174 
175     /**
176      * Return all disposition messages
177      *
178      * @param $bool
179      * @return $this
180      */
181     public function addReturnDispositionMessages($bool = true)
182     {
183         $this->addReturnDispositions();
184         return $this->addParam('return_msg', (bool) $bool);
185     }
186 
187 
188     /**
189      * Return all domains
190      *
191      * @param $bool
192      * @return $this
193      */
194     public function addReturnDomain($bool = true)
195     {
196         return $this->addParam('return_domain', (bool) $bool);
197     }
198 
199     /**
200      * Return all domainQuotas
201      *
202      * @param $bool
203      * @return $this
204      */
205     public function addReturnDomainQuotas($bool = true)
206     {
207         return $this->addParam('return_domcon', (bool) $bool);
208     }
209 
210     /**
211      * Return customer-data
212      *
213      * @param $bool
214      * @return $this
215      */
216     public function addReturnCustomer($bool = true)
217     {
218         return $this->addParam('return_customer', (bool) $bool);
219     }
220 
221     /**
222      * Return customer-address
223      *
224      * @param $bool
225      * @return $this
226      */
227     public function addReturnCustomerAddress($bool = true)
228     {
229         $this->addReturnCustomer();
230         return $this->addParam('return_adress', (bool) $bool);
231     }
232 
233     /**
234      * Return customer-overview
235      *
236      * @param $bool
237      * @return $this
238      */
239     public function addReturnCustomerOverview($bool = true)
240     {
241         $this->addReturnCustomer();
242         return $this->addParam('return_customer_overview', (bool) $bool);
243     }
244 
245     /**
246      * Return limits
247      *
248      * @param $bool
249      * @return $this
250      */
251     public function addReturnLimits($bool = true)
252     {
253         return $this->addParam('return_limits', (bool) $bool);
254     }
255 
256     /**
257      * Return only limit limits
258      *
259      * @param $bool
260      * @return $this
261      */
262     public function addReturnLimitLimits($bool = true)
263     {
264         $this->addReturnLimits();
265         return $this->addParam('return_max_only', (bool) $bool);
266     }
267 
268     /**
269      * Return load
270      *
271      * @param $bool
272      * @return $this
273      */
274     public function addReturnLoad($bool = true)
275     {
276         return $this->addParam('return_load', (bool) $bool);
277     }
278 
279     /**
280      * Return termination status
281      *
282      * @param $bool
283      * @return $this
284      */
285     public function addReturnTerminationStatus($bool = true)
286     {
287         return $this->addParam('return_is_canceled', (bool) $bool);
288     }
289 
290     /**
291      * Return treaty group id
292      *
293      * @param $bool
294      * @return $this
295      */
296     public function addReturnScale($bool = true)
297     {
298         return $this->addParam('return_scale', (bool) $bool);
299     }
300 
301     /**
302      * Return tariff
303      *
304      * @param $bool
305      * @return $this
306      */
307     public function addReturnTariff($bool = true)
308     {
309         return $this->addParam('return_tariff', (bool) $bool);
310     }
311 }

API documentation generated by ApiGen