bump product version to 6.3.0.0.beta1
[LibreOffice.git] / scaddins / idl / com / sun / star / sheet / addin / XAnalysis.idl
blob24142964efb824d53d324b2fcdcb109628110816
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
20 #ifndef com_sun_star_sheet_addin_XAnalysis_idl
21 #define com_sun_star_sheet_addin_XAnalysis_idl
23 #include <com/sun/star/uno/XInterface.idl>
24 #include <com/sun/star/beans/XPropertySet.idl>
25 #include <com/sun/star/sheet/NoConvergenceException.idl>
27 module com
29 module sun
31 module star
33 module sheet
35 module addin
37 /**
38 * Interface with analysis functions.
40 interface XAnalysis : com::sun::star::uno::XInterface
42 /// workday.
43 long getWorkday(
44 [in] com::sun::star::beans::XPropertySet xOptions,
45 [in] long nStartDate, [in] long nDays, [in] any aHolidays )
46 raises( com::sun::star::lang::IllegalArgumentException );
48 /// yearfrac.
49 double getYearfrac(
50 [in] com::sun::star::beans::XPropertySet xOptions,
51 [in] long StartDate, [in] long EndDate, [in] any Mode )
52 raises( com::sun::star::lang::IllegalArgumentException );
54 /// edate.
55 long getEdate(
56 [in] com::sun::star::beans::XPropertySet xOptions,
57 [in] long nStartDate, [in] long nNumOfMonths )
58 raises( com::sun::star::lang::IllegalArgumentException );
60 /// weeknum.
61 long getWeeknum(
62 [in] com::sun::star::beans::XPropertySet xOptions,
63 [in] long nStartDate, [in] long nMode )
64 raises( com::sun::star::lang::IllegalArgumentException );
66 /// eomonth.
67 long getEomonth(
68 [in] com::sun::star::beans::XPropertySet xOptions,
69 [in] long nStartDate, [in] long nMonths )
70 raises( com::sun::star::lang::IllegalArgumentException );
72 /// networkdays.
73 long getNetworkdays(
74 [in] com::sun::star::beans::XPropertySet xOptions,
75 [in] long StartDate, [in] long EndDate, [in] any Holidays )
76 raises( com::sun::star::lang::IllegalArgumentException );
78 /// iseven.
79 long getIseven( [in] long nValue )
80 raises( com::sun::star::lang::IllegalArgumentException );
82 /// isodd.
83 long getIsodd( [in] long nValue )
84 raises( com::sun::star::lang::IllegalArgumentException );
86 /// multinomial.
87 double getMultinomial(
88 [in] com::sun::star::beans::XPropertySet xOptions,
89 [in] sequence< sequence< long > > aValList,
90 [in] sequence< any > aOptVLst )
91 raises( com::sun::star::lang::IllegalArgumentException );
93 /// seriessum.
94 double getSeriessum(
95 [in] double X, [in] double N, [in] double M,
96 [in] sequence< sequence< double > > CoeffList )
97 raises( com::sun::star::lang::IllegalArgumentException );
99 // quotient.
100 double getQuotient( [in] double Num, [in] double Denum )
101 raises( com::sun::star::lang::IllegalArgumentException );
103 // mround.
104 double getMround( [in] double Number, [in] double Multiple )
105 raises( com::sun::star::lang::IllegalArgumentException );
107 // sqrtpi.
108 double getSqrtpi( [in] double Number )
109 raises( com::sun::star::lang::IllegalArgumentException );
111 // randbetween.
112 // Min is the smallest value randbetween will return
113 // Max is the largest value randbetween will return
114 double getRandbetween( [in] double Min, [in] double Max )
115 raises( com::sun::star::lang::IllegalArgumentException );
117 /// gcd.
118 double getGcd(
119 [in] com::sun::star::beans::XPropertySet xOptions,
120 [in] sequence< sequence< double > > FirstValList,
121 [in] sequence< any > OptionalValList )
122 raises( com::sun::star::lang::IllegalArgumentException );
124 /// lcm.
125 double getLcm(
126 [in] com::sun::star::beans::XPropertySet xOptions,
127 [in] sequence< sequence< double > > FirstValList,
128 [in] sequence< any > OptionalValList )
129 raises( com::sun::star::lang::IllegalArgumentException );
131 /// besseli.
132 double getBesseli( [in] double Num, [in] long Order )
133 raises( com::sun::star::lang::IllegalArgumentException,
134 com::sun::star::sheet::NoConvergenceException );
136 /// besselj.
137 double getBesselj( [in] double Num, [in] long Order )
138 raises( com::sun::star::lang::IllegalArgumentException,
139 com::sun::star::sheet::NoConvergenceException );
141 /// besselk.
142 double getBesselk( [in] double Num, [in] long Order )
143 raises( com::sun::star::lang::IllegalArgumentException,
144 com::sun::star::sheet::NoConvergenceException );
146 /// bessely.
147 double getBessely( [in] double Num, [in] long Order )
148 raises( com::sun::star::lang::IllegalArgumentException,
149 com::sun::star::sheet::NoConvergenceException );
151 /// bin2oct.
152 string getBin2Oct(
153 [in] com::sun::star::beans::XPropertySet xOptions,
154 [in] string BinaryNum, [in] any Places )
155 raises( com::sun::star::lang::IllegalArgumentException );
157 /// bin2dec.
158 double getBin2Dec( [in] string BinaryNum )
159 raises( com::sun::star::lang::IllegalArgumentException );
161 /// bin2hex.
162 string getBin2Hex(
163 [in] com::sun::star::beans::XPropertySet xOptions,
164 [in] string BinaryNum, [in] any Places )
165 raises( com::sun::star::lang::IllegalArgumentException );
167 /// oct2bin.
168 string getOct2Bin(
169 [in] com::sun::star::beans::XPropertySet xOptions,
170 [in] string OctalNum, [in] any Places )
171 raises( com::sun::star::lang::IllegalArgumentException );
173 /// oct2dec.
174 double getOct2Dec( [in] string OctalNum )
175 raises( com::sun::star::lang::IllegalArgumentException );
177 /// oct2hex.
178 string getOct2Hex(
179 [in] com::sun::star::beans::XPropertySet xOptions,
180 [in] string OctalNum, [in] any Places )
181 raises( com::sun::star::lang::IllegalArgumentException );
183 /// dec2bin.
184 string getDec2Bin(
185 [in] com::sun::star::beans::XPropertySet xOptions,
186 [in] long Value, [in] any Places )
187 raises( com::sun::star::lang::IllegalArgumentException );
189 /// dec2oct.
190 string getDec2Oct(
191 [in] com::sun::star::beans::XPropertySet xOptions,
192 [in] long Value, [in] any Places )
193 raises( com::sun::star::lang::IllegalArgumentException );
195 /// dec2hex.
196 string getDec2Hex(
197 [in] com::sun::star::beans::XPropertySet xOptions,
198 [in] double Value, [in] any Places )
199 raises( com::sun::star::lang::IllegalArgumentException );
201 /// hex2bin.
202 string getHex2Bin(
203 [in] com::sun::star::beans::XPropertySet xOptions,
204 [in] string HexadecimalValue, [in] any Places )
205 raises( com::sun::star::lang::IllegalArgumentException );
207 /// hex2dec.
208 double getHex2Dec( [in] string HexadecimalValue )
209 raises( com::sun::star::lang::IllegalArgumentException );
211 /// hex2oct.
212 string getHex2Oct(
213 [in] com::sun::star::beans::XPropertySet xOptions,
214 [in] string HexadecimalValue, [in] any Places )
215 raises( com::sun::star::lang::IllegalArgumentException );
217 /// delta.
218 long getDelta(
219 [in] com::sun::star::beans::XPropertySet xOptions,
220 [in] double Num1, [in] any Num2 )
221 raises( com::sun::star::lang::IllegalArgumentException );
223 /// erf.
224 double getErf(
225 [in] com::sun::star::beans::XPropertySet xOptions,
226 [in] double LowerLimit, [in] any UpperLimit )
227 raises( com::sun::star::lang::IllegalArgumentException );
229 /// erfc.
230 double getErfc( [in] double LowerLimit )
231 raises( com::sun::star::lang::IllegalArgumentException );
233 /// gestep.
234 long getGestep(
235 [in] com::sun::star::beans::XPropertySet xOptions,
236 [in] double Num, [in] any Step )
237 raises( com::sun::star::lang::IllegalArgumentException );
239 /// factdouble.
240 double getFactdouble( [in] long Num )
241 raises( com::sun::star::lang::IllegalArgumentException );
243 /// imabs.
244 double getImabs( [in] string Num )
245 raises( com::sun::star::lang::IllegalArgumentException );
247 /// imaginary.
248 double getImaginary( [in] string Num )
249 raises( com::sun::star::lang::IllegalArgumentException );
251 /// impower.
252 string getImpower( [in] string Num, [in] double Power )
253 raises( com::sun::star::lang::IllegalArgumentException );
255 /// imargument.
256 double getImargument( [in] string Num )
257 raises( com::sun::star::lang::IllegalArgumentException );
259 /// imcos.
260 string getImcos( [in] string Num )
261 raises( com::sun::star::lang::IllegalArgumentException );
263 /// imdiv.
264 string getImdiv( [in] string Num1, [in] string Num2 )
265 raises( com::sun::star::lang::IllegalArgumentException );
267 /// imexp.
268 string getImexp( [in] string Num )
269 raises( com::sun::star::lang::IllegalArgumentException );
271 /// imconjugate.
272 string getImconjugate( [in] string Num )
273 raises( com::sun::star::lang::IllegalArgumentException );
275 /// imln.
276 string getImln( [in] string Num )
277 raises( com::sun::star::lang::IllegalArgumentException );
279 /// imlog10.
280 string getImlog10( [in] string Num )
281 raises( com::sun::star::lang::IllegalArgumentException );
283 /// imlog2.
284 string getImlog2( [in] string Num )
285 raises( com::sun::star::lang::IllegalArgumentException );
287 /// improduct.
288 string getImproduct(
289 [in] com::sun::star::beans::XPropertySet xOptions,
290 [in] sequence< sequence< string > > Num1,
291 [in] sequence< any > NumberList )
292 raises( com::sun::star::lang::IllegalArgumentException );
294 /// imreal.
295 double getImreal( [in] string Num )
296 raises( com::sun::star::lang::IllegalArgumentException );
298 /// imsin.
299 string getImsin( [in] string Num )
300 raises( com::sun::star::lang::IllegalArgumentException );
302 /// imsub.
303 string getImsub( [in] string Num1, [in] string Num2 )
304 raises( com::sun::star::lang::IllegalArgumentException );
306 /// imsum.
307 string getImsum(
308 [in] com::sun::star::beans::XPropertySet xOptions,
309 [in] sequence< sequence< string > > Num1,
310 [in] sequence< any > OptNums )
311 raises( com::sun::star::lang::IllegalArgumentException );
313 /// imsqrt.
314 string getImsqrt( [in] string Num )
315 raises( com::sun::star::lang::IllegalArgumentException );
317 /// imtan.
318 string getImtan( [in] string Num )
319 raises( com::sun::star::lang::IllegalArgumentException );
321 /// imsec.
322 string getImsec( [in] string Num)
323 raises( com::sun::star::lang::IllegalArgumentException );
325 /// imcsc.
326 string getImcsc( [in] string Num )
327 raises( com::sun::star::lang::IllegalArgumentException );
329 /// imcot.
330 string getImcot( [in] string Num )
331 raises( com::sun::star::lang::IllegalArgumentException );
333 /// imsinh.
334 string getImsinh( [in] string Num )
335 raises( com::sun::star::lang::IllegalArgumentException );
337 /// imcosh.
338 string getImcosh( [in] string Num )
339 raises( com::sun::star::lang::IllegalArgumentException );
341 /// imsech.
342 string getImsech( [in] string Num)
343 raises( com::sun::star::lang::IllegalArgumentException );
345 /// imcsch.
346 string getImcsch( [in] string Num )
347 raises( com::sun::star::lang::IllegalArgumentException );
349 /// complex.
350 string getComplex( [in] double Real, [in] double Imaginary, [in] any Suffix )
351 raises( com::sun::star::lang::IllegalArgumentException );
353 /// convert.
354 double getConvert( [in] double Value, [in] string FromUnit, [in] string ToUnit )
355 raises( com::sun::star::lang::IllegalArgumentException );
358 /// amordegrc.
359 double getAmordegrc(
360 [in] com::sun::star::beans::XPropertySet xOptions,
361 [in] double Cost, [in] long Date, [in] long FirstPer, [in] double RestVal,
362 [in] double Periode, [in] double Rate, [in] any Base )
363 raises( com::sun::star::lang::IllegalArgumentException );
365 /// amorlinc.
366 double getAmorlinc(
367 [in] com::sun::star::beans::XPropertySet xOptions,
368 [in] double Cost, [in] long Date, [in] long FirstPer, [in] double RestVal,
369 [in] double Periode, [in] double Rate, [in] any Base )
370 raises( com::sun::star::lang::IllegalArgumentException );
372 /// accrint.
373 double getAccrint(
374 [in] com::sun::star::beans::XPropertySet xOptions,
375 [in] long Issue, [in] long FirstInterest, [in] long Settlement, [in] double Rate,
376 [in] any Value, [in] long Frequency, [in] any Base )
377 raises( com::sun::star::lang::IllegalArgumentException );
379 /// accrintm.
380 double getAccrintm(
381 [in] com::sun::star::beans::XPropertySet xOptions,
382 [in] long Issue, [in] long Settlement, [in] double Rate, [in] any Value, [in] any Base )
383 raises( com::sun::star::lang::IllegalArgumentException );
385 /// received.
386 double getReceived(
387 [in] com::sun::star::beans::XPropertySet xOptions,
388 [in] long Settlement, [in] long Maturity, [in] double Investment, [in] double Discount,
389 [in] any Base )
390 raises( com::sun::star::lang::IllegalArgumentException );
392 /// disc.
393 double getDisc(
394 [in] com::sun::star::beans::XPropertySet xOptions,
395 [in] long Settlement, [in] long Maturity, [in] double Price, [in] double Redemption,
396 [in] any Base )
397 raises( com::sun::star::lang::IllegalArgumentException );
399 /// duration.
400 double getDuration(
401 [in] com::sun::star::beans::XPropertySet xOptions,
402 [in] long Settlement, [in] long Maturity, [in] double Coupon, [in] double Yield,
403 [in] long Frequency, [in] any Base )
404 raises( com::sun::star::lang::IllegalArgumentException );
406 /// effect.
407 double getEffect( [in] double Nomial, [in] long NumOfPeriods )
408 raises( com::sun::star::lang::IllegalArgumentException );
410 /// cumprinc.
411 double getCumprinc(
412 [in] double Rate, [in] long NumOfPeriods, [in] double Val, [in] long StartPeriode,
413 [in] long EndPeriode, [in] long PayType )
414 raises( com::sun::star::lang::IllegalArgumentException );
416 /// cumipmt.
417 double getCumipmt(
418 [in] double Rate, [in] long NumOfPeriods, [in] double Val, [in] long StartPeriode,
419 [in] long EndPeriode, [in] long PayType )
420 raises( com::sun::star::lang::IllegalArgumentException );
422 /// price.
423 double getPrice(
424 [in] com::sun::star::beans::XPropertySet xOptions,
425 [in] long Settlement, [in] long Maturity, [in] double Rate, [in] double Yield,
426 [in] double Redemption, [in] long Frequency, [in] any Base )
427 raises( com::sun::star::lang::IllegalArgumentException );
429 /// pricedisc.
430 double getPricedisc(
431 [in] com::sun::star::beans::XPropertySet xOptions,
432 [in] long Settlement, [in] long Maturity, [in] double Discont, [in] double Redemption,
433 [in] any Base )
434 raises( com::sun::star::lang::IllegalArgumentException );
436 /// pricemat.
437 double getPricemat(
438 [in] com::sun::star::beans::XPropertySet xOptions,
439 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] double Rate, [in] double Yield,
440 [in] any Base )
441 raises( com::sun::star::lang::IllegalArgumentException );
443 /// mduration.
444 double getMduration(
445 [in] com::sun::star::beans::XPropertySet xOptions,
446 [in] long Settlement, [in] long Maturity, [in] double Coupon, [in] double Yield,
447 [in] long Frequency, [in] any Base )
448 raises( com::sun::star::lang::IllegalArgumentException );
450 /// nominal.
451 double getNominal( [in] double Rate, [in] long NumOfPeriods )
452 raises( com::sun::star::lang::IllegalArgumentException );
454 /// dollarfr.
455 double getDollarfr( [in] double DollarDecimal, [in] long Fraction )
456 raises( com::sun::star::lang::IllegalArgumentException );
458 /// dollarde.
459 double getDollarde( [in] double DollarFractional, [in] long Fraction )
460 raises( com::sun::star::lang::IllegalArgumentException );
462 /// yield.
463 double getYield(
464 [in] com::sun::star::beans::XPropertySet xOptions,
465 [in] long Settlement, [in] long Maturity, [in] double Coupon, [in] double Price,
466 [in] double Redemption, [in] long Frequency, [in] any Base )
467 raises( com::sun::star::lang::IllegalArgumentException );
469 /// yielddisc.
470 double getYielddisc(
471 [in] com::sun::star::beans::XPropertySet xOptions,
472 [in] long Settlement, [in] long Maturity, [in] double Price,
473 [in] double Redemption, [in] any Base )
474 raises( com::sun::star::lang::IllegalArgumentException );
476 /// yieldmat.
477 double getYieldmat(
478 [in] com::sun::star::beans::XPropertySet xOptions,
479 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] double Rate,
480 [in] double Price, [in] any Base )
481 raises( com::sun::star::lang::IllegalArgumentException );
483 /// tbilleq.
484 double getTbilleq(
485 [in] com::sun::star::beans::XPropertySet xOptions,
486 [in] long Settlement, [in] long Maturity, [in] double Discont )
487 raises( com::sun::star::lang::IllegalArgumentException );
489 /// tbillprice.
490 double getTbillprice(
491 [in] com::sun::star::beans::XPropertySet xOptions,
492 [in] long Settlement, [in] long Maturity, [in] double Discont )
493 raises( com::sun::star::lang::IllegalArgumentException );
495 /// tbillyield.
496 double getTbillyield(
497 [in] com::sun::star::beans::XPropertySet xOptions,
498 [in] long Settlement, [in] long Maturity, [in] double Price )
499 raises( com::sun::star::lang::IllegalArgumentException );
501 /// oddfprice.
502 double getOddfprice(
503 [in] com::sun::star::beans::XPropertySet xOptions,
504 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] long FirstCouponDate,
505 [in] double Rate, [in] double Yield, [in] double Redemption,
506 [in] long Frequency, [in] any Base )
507 raises( com::sun::star::lang::IllegalArgumentException );
509 /// oddfyield.
510 double getOddfyield(
511 [in] com::sun::star::beans::XPropertySet xOptions,
512 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] long FirstCouponDate,
513 [in] double Rate, [in] double Price, [in] double Redemption,
514 [in] long Frequency, [in] any Base )
515 raises( com::sun::star::lang::IllegalArgumentException );
517 /// oddlprice.
518 double getOddlprice(
519 [in] com::sun::star::beans::XPropertySet xOptions,
520 [in] long Settlement, [in] long Maturity, [in] long LastInterest,
521 [in] double Rate, [in] double Yield, [in] double Redemption,
522 [in] long Frequency, [in] any Base )
523 raises( com::sun::star::lang::IllegalArgumentException );
525 /// oddlyield.
526 double getOddlyield(
527 [in] com::sun::star::beans::XPropertySet xOptions,
528 [in] long Settlement, [in] long Maturity, [in] long LastInterest,
529 [in] double Rate, [in] double Price, [in] double Redemption,
530 [in] long Frequency, [in] any Base )
531 raises( com::sun::star::lang::IllegalArgumentException );
533 /// xirr.
534 double getXirr(
535 [in] com::sun::star::beans::XPropertySet xOptions,
536 [in] sequence< sequence< double > > Values,
537 [in] sequence< sequence< long > > Dates, [in] any Guess )
538 raises( com::sun::star::lang::IllegalArgumentException );
540 /// xnpv.
541 double getXnpv(
542 [in] double Rate,
543 [in] sequence< sequence< double > > Values,
544 [in] sequence< sequence< long > > Dates )
545 raises( com::sun::star::lang::IllegalArgumentException );
547 /// intrate.
548 double getIntrate(
549 [in] com::sun::star::beans::XPropertySet xOptions,
550 [in] long Settlement, [in] long Maturity,
551 [in] double Investment, [in] double Redemption, [in] any Base )
552 raises( com::sun::star::lang::IllegalArgumentException );
554 /// coupncd.
555 double getCoupncd(
556 [in] com::sun::star::beans::XPropertySet xOptions,
557 [in] long Settlement, [in] long Maturity,
558 [in] long Frequency, [in] any Base )
559 raises( com::sun::star::lang::IllegalArgumentException );
561 /// coupdays.
562 double getCoupdays(
563 [in] com::sun::star::beans::XPropertySet xOptions,
564 [in] long Settlement, [in] long Maturity,
565 [in] long Frequency, [in] any Base )
566 raises( com::sun::star::lang::IllegalArgumentException );
569 /// coupdaysnc.
570 double getCoupdaysnc(
571 [in] com::sun::star::beans::XPropertySet xOptions,
572 [in] long Settlement, [in] long Maturity,
573 [in] long Frequency, [in] any Base )
574 raises( com::sun::star::lang::IllegalArgumentException );
576 /// coupdaybs.
577 double getCoupdaybs(
578 [in] com::sun::star::beans::XPropertySet xOptions,
579 [in] long Settlement, [in] long Maturity,
580 [in] long Frequency, [in] any Base )
581 raises( com::sun::star::lang::IllegalArgumentException );
583 /// couppcd.
584 double getCouppcd(
585 [in] com::sun::star::beans::XPropertySet xOptions,
586 [in] long Settlement, [in] long Maturity,
587 [in] long Frequency, [in] any Base )
588 raises( com::sun::star::lang::IllegalArgumentException );
590 /// coupnum.
591 double getCoupnum(
592 [in] com::sun::star::beans::XPropertySet xOptions,
593 [in] long Settlement, [in] long Maturity,
594 [in] long Frequency, [in] any Base )
595 raises( com::sun::star::lang::IllegalArgumentException );
597 /// fvschedule.
598 double getFvschedule( [in] double Principal, [in] sequence< sequence< double > > Schedule )
599 raises( com::sun::star::lang::IllegalArgumentException );
607 #endif
609 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */