scaddins/source/datefunc/dateadd.idl

   1 /*************************************************************************
   2 *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: dateadd.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29 ************************************************************************/
  30
  31
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #include <com/sun/star/beans/XPropertySet.idl>
  34 #include <com/sun/star/sheet/LocalizedName.idl>
  35
  36 module com
  37 {
  38 module sun
  39 {
  40 module star
  41 {
  42 module sheet
  43 {
  44 module addin
  45 {
  46     interface XCompatibilityNames  : com::sun::star::uno::XInterface
  47     {
  48         /// @return a sequence with all localized names for a programmatic name
  49         sequence< com::sun::star::sheet::LocalizedName > getCompatibilityNames ( [in] string aProgrammaticName );
  50     };
  51
  52     /**
  53      * Interface with date functions.
  54      */
  55     interface XDateFunctions : com::sun::star::uno::XInterface
  56     {
  57         /// calculates the number of weeks between two dates.
  58         long getDiffWeeks(
  59                     [in] com::sun::star::beans::XPropertySet xOptions,
  60                     [in] long nStartDate, [in] long nEndDate, [in] long nMode )
  61             raises( com::sun::star::lang::IllegalArgumentException );
  62
  63         /// calculates the number of months between two dates.
  64         long getDiffMonths(
  65                     [in] com::sun::star::beans::XPropertySet xOptions,
  66                     [in] long nStartDate, [in] long nEndDate, [in] long nMode )
  67             raises( com::sun::star::lang::IllegalArgumentException );
  68
  69         /// calculates the number of years between two dates.
  70         long getDiffYears(
  71                     [in] com::sun::star::beans::XPropertySet xOptions,
  72                     [in] long nStartDate, [in] long nEndDate, [in] long nMode )
  73             raises( com::sun::star::lang::IllegalArgumentException );
  74
  75         /// checks if a date is in a leap year.
  76         long getIsLeapYear(
  77                     [in] com::sun::star::beans::XPropertySet xOptions,
  78                     [in] long nDate )
  79             raises( com::sun::star::lang::IllegalArgumentException );
  80
  81         /// calculates the number of days in a month.
  82         long getDaysInMonth(
  83                     [in] com::sun::star::beans::XPropertySet xOptions,
  84                     [in] long nDate )
  85             raises( com::sun::star::lang::IllegalArgumentException );
  86
  87         /// calculates the number of days in a year.
  88         long getDaysInYear(
  89                     [in] com::sun::star::beans::XPropertySet xOptions,
  90                     [in] long nDate )
  91             raises( com::sun::star::lang::IllegalArgumentException );
  92
  93         /// calculates the number of weeks in a year.
  94         long getWeeksInYear(
  95                     [in] com::sun::star::beans::XPropertySet xOptions,
  96                     [in] long nDate )
  97             raises( com::sun::star::lang::IllegalArgumentException );
  98     };
  99
 100     /**
 101      * Interface with miscellaneous functions.
 102      */
 103     interface XMiscFunctions : com::sun::star::uno::XInterface
 104     {
 105         /// Encrypts or decrypts a string using the ROT13 algorithm.
 106         string getRot13( [in] string aSrcString )
 107             raises( com::sun::star::lang::IllegalArgumentException );
 108     };
 109
 110     service DateFunctions
 111     {
 112         // exported interfaces:
 113         interface XDateFunctions;
 114         interface XMiscFunctions;
 115     };
 116 };
 117 };
 118 };
 119 };
 120 };
 121