Update ooo320-m1
[ooovba.git] / scaddins / source / analysis / analysisadd.idl
blobfa8da32eab371d818a7ef4218758bbaffcbe477b
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: analysisadd.idl,v $
10 * $Revision: 1.14 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
32 #include <com/sun/star/uno/XInterface.idl>
33 #include <com/sun/star/beans/XPropertySet.idl>
34 #include <com/sun/star/sheet/LocalizedName.idl>
36 module com
38 module sun
40 module star
42 module sheet
44 module addin
46 interface XCompatibilityNames : com::sun::star::uno::XInterface
48 /// getCompatibilityNames.
49 sequence< com::sun::star::sheet::LocalizedName > getCompatibilityNames ( [in] string aProgrammaticName );
52 /**
53 * Interface with analysis functions.
55 interface XAnalysis : com::sun::star::uno::XInterface
57 /// _test.
58 // double get_Test(
59 // [in] com::sun::star::beans::XPropertySet xOptions,
60 // [in] long Mode, [in] double f1, [in] double f2, [in] double f3 );
62 /// workday.
63 long getWorkday(
64 [in] com::sun::star::beans::XPropertySet xOptions,
65 [in] long nStartDate, [in] long nDays, [in] any aHolidays )
66 raises( com::sun::star::lang::IllegalArgumentException );
68 /// yearfrac.
69 double getYearfrac(
70 [in] com::sun::star::beans::XPropertySet xOptions,
71 [in] long StartDate, [in] long EndDate, [in] any Mode )
72 raises( com::sun::star::lang::IllegalArgumentException );
74 /// edate.
75 long getEdate(
76 [in] com::sun::star::beans::XPropertySet xOptions,
77 [in] long nStartDate, [in] long nNumOfMonths )
78 raises( com::sun::star::lang::IllegalArgumentException );
80 /// weeknum.
81 long getWeeknum(
82 [in] com::sun::star::beans::XPropertySet xOptions,
83 [in] long nStartDate, [in] long nMode )
84 raises( com::sun::star::lang::IllegalArgumentException );
86 /// eomonth.
87 long getEomonth(
88 [in] com::sun::star::beans::XPropertySet xOptions,
89 [in] long nStartDate, [in] long nMonths )
90 raises( com::sun::star::lang::IllegalArgumentException );
92 /// networkdays.
93 long getNetworkdays(
94 [in] com::sun::star::beans::XPropertySet xOptions,
95 [in] long StartDate, [in] long EndDate, [in] any Holidays )
96 raises( com::sun::star::lang::IllegalArgumentException );
98 /// iseven.
99 long getIseven( [in] long nValue )
100 raises( com::sun::star::lang::IllegalArgumentException );
102 /// isodd.
103 long getIsodd( [in] long nValue )
104 raises( com::sun::star::lang::IllegalArgumentException );
106 /// multinomial.
107 double getMultinomial(
108 [in] com::sun::star::beans::XPropertySet xOptions,
109 [in] sequence< sequence< long > > aValList,
110 [in] sequence< any > aOptVLst )
111 raises( com::sun::star::lang::IllegalArgumentException );
113 /// seriessum.
114 double getSeriessum(
115 [in] double X, [in] double N, [in] double M,
116 [in] sequence< sequence< double > > CoeffList )
117 raises( com::sun::star::lang::IllegalArgumentException );
119 // quotient.
120 double getQuotient( [in] double Num, [in] double Denum )
121 raises( com::sun::star::lang::IllegalArgumentException );
123 // mround.
124 double getMround( [in] double Number, [in] double Multiple )
125 raises( com::sun::star::lang::IllegalArgumentException );
127 // sqrtpi.
128 double getSqrtpi( [in] double Number )
129 raises( com::sun::star::lang::IllegalArgumentException );
131 // randbetween.
132 double getRandbetween( [in] double Min, [in] double Max )
133 raises( com::sun::star::lang::IllegalArgumentException );
135 /// gcd.
136 double getGcd(
137 [in] com::sun::star::beans::XPropertySet xOptions,
138 [in] sequence< sequence< double > > FirstValList,
139 [in] sequence< any > OptionalValList )
140 raises( com::sun::star::lang::IllegalArgumentException );
142 /// lcm.
143 double getLcm(
144 [in] com::sun::star::beans::XPropertySet xOptions,
145 [in] sequence< sequence< double > > FirstValList,
146 [in] sequence< any > OptionalValList )
147 raises( com::sun::star::lang::IllegalArgumentException );
149 /// besseli.
150 double getBesseli( [in] double Num, [in] long Order )
151 raises( com::sun::star::lang::IllegalArgumentException );
153 /// besselj.
154 double getBesselj( [in] double Num, [in] long Order )
155 raises( com::sun::star::lang::IllegalArgumentException );
157 /// besselk.
158 double getBesselk( [in] double Num, [in] long Order )
159 raises( com::sun::star::lang::IllegalArgumentException );
161 /// bessely.
162 double getBessely( [in] double Num, [in] long Order )
163 raises( com::sun::star::lang::IllegalArgumentException );
165 /// bin2oct.
166 string getBin2Oct(
167 [in] com::sun::star::beans::XPropertySet xOptions,
168 [in] string BinaryNum, [in] any Places )
169 raises( com::sun::star::lang::IllegalArgumentException );
171 /// bin2dec.
172 double getBin2Dec( [in] string BinaryNum )
173 raises( com::sun::star::lang::IllegalArgumentException );
175 /// bin2hex.
176 string getBin2Hex(
177 [in] com::sun::star::beans::XPropertySet xOptions,
178 [in] string BinaryNum, [in] any Places )
179 raises( com::sun::star::lang::IllegalArgumentException );
181 /// oct2bin.
182 string getOct2Bin(
183 [in] com::sun::star::beans::XPropertySet xOptions,
184 [in] string OctalNum, [in] any Places )
185 raises( com::sun::star::lang::IllegalArgumentException );
187 /// oct2dec.
188 double getOct2Dec( [in] string OctalNum )
189 raises( com::sun::star::lang::IllegalArgumentException );
191 /// oct2hex.
192 string getOct2Hex(
193 [in] com::sun::star::beans::XPropertySet xOptions,
194 [in] string OctalNum, [in] any Places )
195 raises( com::sun::star::lang::IllegalArgumentException );
197 /// dec2bin.
198 string getDec2Bin(
199 [in] com::sun::star::beans::XPropertySet xOptions,
200 [in] long Value, [in] any Places )
201 raises( com::sun::star::lang::IllegalArgumentException );
203 /// dec2oct.
204 string getDec2Oct(
205 [in] com::sun::star::beans::XPropertySet xOptions,
206 [in] long Value, [in] any Places )
207 raises( com::sun::star::lang::IllegalArgumentException );
209 /// dec2hex.
210 string getDec2Hex(
211 [in] com::sun::star::beans::XPropertySet xOptions,
212 [in] double Value, [in] any Places )
213 raises( com::sun::star::lang::IllegalArgumentException );
215 /// hex2bin.
216 string getHex2Bin(
217 [in] com::sun::star::beans::XPropertySet xOptions,
218 [in] string HexadecimalValue, [in] any Places )
219 raises( com::sun::star::lang::IllegalArgumentException );
221 /// hex2dec.
222 double getHex2Dec( [in] string HexadecimalValue )
223 raises( com::sun::star::lang::IllegalArgumentException );
225 /// hex2oct.
226 string getHex2Oct(
227 [in] com::sun::star::beans::XPropertySet xOptions,
228 [in] string HexadecimalValue, [in] any Places )
229 raises( com::sun::star::lang::IllegalArgumentException );
231 /// delta.
232 long getDelta(
233 [in] com::sun::star::beans::XPropertySet xOptions,
234 [in] double Num1, [in] any Num2 )
235 raises( com::sun::star::lang::IllegalArgumentException );
237 /// erf.
238 double getErf(
239 [in] com::sun::star::beans::XPropertySet xOptions,
240 [in] double LowerLimit, [in] any UpperLimit )
241 raises( com::sun::star::lang::IllegalArgumentException );
243 /// erfc.
244 double getErfc( [in] double LowerLimit )
245 raises( com::sun::star::lang::IllegalArgumentException );
247 /// gestep.
248 long getGestep(
249 [in] com::sun::star::beans::XPropertySet xOptions,
250 [in] double Num, [in] any Step )
251 raises( com::sun::star::lang::IllegalArgumentException );
253 /// factdouble.
254 double getFactdouble( [in] long Num )
255 raises( com::sun::star::lang::IllegalArgumentException );
257 /// imabs.
258 double getImabs( [in] string Num )
259 raises( com::sun::star::lang::IllegalArgumentException );
261 /// imaginary.
262 double getImaginary( [in] string Num )
263 raises( com::sun::star::lang::IllegalArgumentException );
265 /// impower.
266 string getImpower( [in] string Num, [in] double Power )
267 raises( com::sun::star::lang::IllegalArgumentException );
269 /// imargument.
270 double getImargument( [in] string Num )
271 raises( com::sun::star::lang::IllegalArgumentException );
273 /// imcos.
274 string getImcos( [in] string Num )
275 raises( com::sun::star::lang::IllegalArgumentException );
277 /// imdiv.
278 string getImdiv( [in] string Num1, [in] string Num2 )
279 raises( com::sun::star::lang::IllegalArgumentException );
281 /// imexp.
282 string getImexp( [in] string Num )
283 raises( com::sun::star::lang::IllegalArgumentException );
285 /// imconjugate.
286 string getImconjugate( [in] string Num )
287 raises( com::sun::star::lang::IllegalArgumentException );
289 /// imln.
290 string getImln( [in] string Num )
291 raises( com::sun::star::lang::IllegalArgumentException );
293 /// imlog10.
294 string getImlog10( [in] string Num )
295 raises( com::sun::star::lang::IllegalArgumentException );
297 /// imlog2.
298 string getImlog2( [in] string Num )
299 raises( com::sun::star::lang::IllegalArgumentException );
301 /// improduct.
302 string getImproduct(
303 [in] com::sun::star::beans::XPropertySet xOptions,
304 [in] sequence< sequence< string > > Num1,
305 [in] sequence< any > NumberList )
306 raises( com::sun::star::lang::IllegalArgumentException );
308 /// imreal.
309 double getImreal( [in] string Num )
310 raises( com::sun::star::lang::IllegalArgumentException );
312 /// imsin.
313 string getImsin( [in] string Num )
314 raises( com::sun::star::lang::IllegalArgumentException );
316 /// imsub.
317 string getImsub( [in] string Num1, [in] string Num2 )
318 raises( com::sun::star::lang::IllegalArgumentException );
320 /// imsum.
321 string getImsum(
322 [in] com::sun::star::beans::XPropertySet xOptions,
323 [in] sequence< sequence< string > > Num1,
324 [in] sequence< any > OptNums )
325 raises( com::sun::star::lang::IllegalArgumentException );
327 /// imsqrt.
328 string getImsqrt( [in] string Num )
329 raises( com::sun::star::lang::IllegalArgumentException );
331 /// complex.
332 string getComplex( [in] double Real, [in] double Imaginary, [in] any Suffix )
333 raises( com::sun::star::lang::IllegalArgumentException );
335 /// convert.
336 double getConvert( [in] double Value, [in] string FromUnit, [in] string ToUnit )
337 raises( com::sun::star::lang::IllegalArgumentException );
340 /// amordegrc.
341 double getAmordegrc(
342 [in] com::sun::star::beans::XPropertySet xOptions,
343 [in] double Cost, [in] long Date, [in] long FirstPer, [in] double RestVal,
344 [in] double Periode, [in] double Rate, [in] any Base )
345 raises( com::sun::star::lang::IllegalArgumentException );
347 /// amorlinc.
348 double getAmorlinc(
349 [in] com::sun::star::beans::XPropertySet xOptions,
350 [in] double Cost, [in] long Date, [in] long FirstPer, [in] double RestVal,
351 [in] double Periode, [in] double Rate, [in] any Base )
352 raises( com::sun::star::lang::IllegalArgumentException );
354 /// accrint.
355 double getAccrint(
356 [in] com::sun::star::beans::XPropertySet xOptions,
357 [in] long Issue, [in] long FirstInterest, [in] long Settlement, [in] double Rate,
358 [in] any Value, [in] long Frequency, [in] any Base )
359 raises( com::sun::star::lang::IllegalArgumentException );
361 /// accrintm.
362 double getAccrintm(
363 [in] com::sun::star::beans::XPropertySet xOptions,
364 [in] long Issue, [in] long Settlement, [in] double Rate, [in] any Value, [in] any Base )
365 raises( com::sun::star::lang::IllegalArgumentException );
367 /// received.
368 double getReceived(
369 [in] com::sun::star::beans::XPropertySet xOptions,
370 [in] long Settlement, [in] long Maturity, [in] double Investment, [in] double Discount,
371 [in] any Base )
372 raises( com::sun::star::lang::IllegalArgumentException );
374 /// disc.
375 double getDisc(
376 [in] com::sun::star::beans::XPropertySet xOptions,
377 [in] long Settlement, [in] long Maturity, [in] double Price, [in] double Redemption,
378 [in] any Base )
379 raises( com::sun::star::lang::IllegalArgumentException );
381 /// duration.
382 double getDuration(
383 [in] com::sun::star::beans::XPropertySet xOptions,
384 [in] long Settlement, [in] long Maturity, [in] double Coupon, [in] double Yield,
385 [in] long Frequncy, [in] any Base )
386 raises( com::sun::star::lang::IllegalArgumentException );
388 /// effect.
389 double getEffect( [in] double Nomial, [in] long NumOfPeriods )
390 raises( com::sun::star::lang::IllegalArgumentException );
392 /// cumprinc.
393 double getCumprinc(
394 [in] double Rate, [in] long NumOfPeriods, [in] double Val, [in] long StartPeriode,
395 [in] long EndPeriode, [in] long PayType )
396 raises( com::sun::star::lang::IllegalArgumentException );
398 /// cumipmt.
399 double getCumipmt(
400 [in] double Rate, [in] long NumOfPeriods, [in] double Val, [in] long StartPeriode,
401 [in] long EndPeriode, [in] long PayType )
402 raises( com::sun::star::lang::IllegalArgumentException );
404 /// price.
405 double getPrice(
406 [in] com::sun::star::beans::XPropertySet xOptions,
407 [in] long Settlement, [in] long Maturity, [in] double Rate, [in] double Yield,
408 [in] double Redemption, [in] long Frequncy, [in] any Base )
409 raises( com::sun::star::lang::IllegalArgumentException );
411 /// pricedisc.
412 double getPricedisc(
413 [in] com::sun::star::beans::XPropertySet xOptions,
414 [in] long Settlement, [in] long Maturity, [in] double Discont, [in] double Redemption,
415 [in] any Base )
416 raises( com::sun::star::lang::IllegalArgumentException );
418 /// pricemat.
419 double getPricemat(
420 [in] com::sun::star::beans::XPropertySet xOptions,
421 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] double Rate, [in] double Yield,
422 [in] any Base )
423 raises( com::sun::star::lang::IllegalArgumentException );
425 /// mduration.
426 double getMduration(
427 [in] com::sun::star::beans::XPropertySet xOptions,
428 [in] long Settlement, [in] long Maturity, [in] double Coupon, [in] double Yield,
429 [in] long Frequency, [in] any Base )
430 raises( com::sun::star::lang::IllegalArgumentException );
432 /// nominal.
433 double getNominal( [in] double Rate, [in] long NumOfPeriods )
434 raises( com::sun::star::lang::IllegalArgumentException );
436 /// dollarfr.
437 double getDollarfr( [in] double DollarDecimal, [in] long Fraction )
438 raises( com::sun::star::lang::IllegalArgumentException );
440 /// dollarde.
441 double getDollarde( [in] double DollarFractional, [in] long Fraction )
442 raises( com::sun::star::lang::IllegalArgumentException );
444 /// yield.
445 double getYield(
446 [in] com::sun::star::beans::XPropertySet xOptions,
447 [in] long Settlement, [in] long Maturity, [in] double Coupon, [in] double Price,
448 [in] double Redemption, [in] long Frequency, [in] any Base )
449 raises( com::sun::star::lang::IllegalArgumentException );
451 /// yielddisc.
452 double getYielddisc(
453 [in] com::sun::star::beans::XPropertySet xOptions,
454 [in] long Settlement, [in] long Maturity, [in] double Price,
455 [in] double Redemption, [in] any Base )
456 raises( com::sun::star::lang::IllegalArgumentException );
458 /// yieldmat.
459 double getYieldmat(
460 [in] com::sun::star::beans::XPropertySet xOptions,
461 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] double Rate,
462 [in] double Price, [in] any Base )
463 raises( com::sun::star::lang::IllegalArgumentException );
465 /// tbilleq.
466 double getTbilleq(
467 [in] com::sun::star::beans::XPropertySet xOptions,
468 [in] long Settlement, [in] long Maturity, [in] double Discont )
469 raises( com::sun::star::lang::IllegalArgumentException );
471 /// tbillprice.
472 double getTbillprice(
473 [in] com::sun::star::beans::XPropertySet xOptions,
474 [in] long Settlement, [in] long Maturity, [in] double Discont )
475 raises( com::sun::star::lang::IllegalArgumentException );
477 /// tbillyield.
478 double getTbillyield(
479 [in] com::sun::star::beans::XPropertySet xOptions,
480 [in] long Settlement, [in] long Maturity, [in] double Price )
481 raises( com::sun::star::lang::IllegalArgumentException );
483 /// oddfprice.
484 double getOddfprice(
485 [in] com::sun::star::beans::XPropertySet xOptions,
486 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] long FirstCouponDate,
487 [in] double Rate, [in] double Yield, [in] double Redemption,
488 [in] long Frequency, [in] any Base )
489 raises( com::sun::star::lang::IllegalArgumentException );
491 /// oddfyield.
492 double getOddfyield(
493 [in] com::sun::star::beans::XPropertySet xOptions,
494 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] long FirstCouponDate,
495 [in] double Rate, [in] double Price, [in] double Redemption,
496 [in] long Frequency, [in] any Base )
497 raises( com::sun::star::lang::IllegalArgumentException );
499 /// oddlprice.
500 double getOddlprice(
501 [in] com::sun::star::beans::XPropertySet xOptions,
502 [in] long Settlement, [in] long Maturity, [in] long LastInterest,
503 [in] double Rate, [in] double Yield, [in] double Redemption,
504 [in] long Frequency, [in] any Base )
505 raises( com::sun::star::lang::IllegalArgumentException );
507 /// oddlyield.
508 double getOddlyield(
509 [in] com::sun::star::beans::XPropertySet xOptions,
510 [in] long Settlement, [in] long Maturity, [in] long LastInterest,
511 [in] double Rate, [in] double Price, [in] double Redemption,
512 [in] long Frequency, [in] any Base )
513 raises( com::sun::star::lang::IllegalArgumentException );
515 /// xirr.
516 double getXirr(
517 [in] com::sun::star::beans::XPropertySet xOptions,
518 [in] sequence< sequence< double > > Values,
519 [in] sequence< sequence< long > > Dates, [in] any Guess )
520 raises( com::sun::star::lang::IllegalArgumentException );
522 /// xnpv.
523 double getXnpv(
524 [in] double Rate,
525 [in] sequence< sequence< double > > Values,
526 [in] sequence< sequence< long > > Dates )
527 raises( com::sun::star::lang::IllegalArgumentException );
529 /// intrate.
530 double getIntrate(
531 [in] com::sun::star::beans::XPropertySet xOptions,
532 [in] long Settlement, [in] long Maturity,
533 [in] double Investment, [in] double Redemption, [in] any Base )
534 raises( com::sun::star::lang::IllegalArgumentException );
536 /// coupncd.
537 double getCoupncd(
538 [in] com::sun::star::beans::XPropertySet xOptions,
539 [in] long Settlement, [in] long Maturity,
540 [in] long Frequency, [in] any Base )
541 raises( com::sun::star::lang::IllegalArgumentException );
543 /// coupdays.
544 double getCoupdays(
545 [in] com::sun::star::beans::XPropertySet xOptions,
546 [in] long Settlement, [in] long Maturity,
547 [in] long Frequency, [in] any Base )
548 raises( com::sun::star::lang::IllegalArgumentException );
551 /// coupdaysnc.
552 double getCoupdaysnc(
553 [in] com::sun::star::beans::XPropertySet xOptions,
554 [in] long Settlement, [in] long Maturity,
555 [in] long Frequency, [in] any Base )
556 raises( com::sun::star::lang::IllegalArgumentException );
558 /// coupdaybs.
559 double getCoupdaybs(
560 [in] com::sun::star::beans::XPropertySet xOptions,
561 [in] long Settlement, [in] long Maturity,
562 [in] long Frequency, [in] any Base )
563 raises( com::sun::star::lang::IllegalArgumentException );
565 /// couppcd.
566 double getCouppcd(
567 [in] com::sun::star::beans::XPropertySet xOptions,
568 [in] long Settlement, [in] long Maturity,
569 [in] long Frequency, [in] any Base )
570 raises( com::sun::star::lang::IllegalArgumentException );
572 /// coupnum.
573 double getCoupnum(
574 [in] com::sun::star::beans::XPropertySet xOptions,
575 [in] long Settlement, [in] long Maturity,
576 [in] long Frequency, [in] any Base )
577 raises( com::sun::star::lang::IllegalArgumentException );
579 /// fvschedule.
580 double getFvschedule( [in] double Principal, [in] sequence< sequence< double > > Schedule )
581 raises( com::sun::star::lang::IllegalArgumentException );
584 service Analysis
586 // exported interfaces:
587 interface XCompatibilityNames;
588 interface XAnalysis;