offapi/com/sun/star/ucb/OpenCommandArgument2.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: OpenCommandArgument2.idl,v $
  10  * $Revision: 1.8 $
  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 #ifndef __com_sun_star_ucb_OpenCommandArgument2_idl__
  31 #define __com_sun_star_ucb_OpenCommandArgument2_idl__
  32
  33 #ifndef __com_sun_star_ucb_OpenCommandArgument_idl__
  34 #include <com/sun/star/ucb/OpenCommandArgument.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_NumberedSortingInfo_idl__
  38 #include <com/sun/star/ucb/NumberedSortingInfo.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module ucb {
  44
  45 //=============================================================================
  46 /** The argument for commands like "open", "update", and "synchronize".
  47
  48     <p>This     strcut extends the original OpenCommandArgument, which must not be
  49     changed for compatibility reasons.
  50
  51     @see XCommandProcessor
  52 */
  53 published struct OpenCommandArgument2 : OpenCommandArgument
  54 {
  55     //-------------------------------------------------------------------------
  56     /** The sort criteria for the rows of the returned
  57         <type>ContentResultSet</type>.
  58
  59         <p>The resultset implementation may ignore this parameter, if it
  60         cannot sort the data by the given criteria in an efficient way (i.e.
  61         directly using the underlying data source -> SQL-database -> ORDER BY).
  62     */
  63     sequence< com::sun::star::ucb::NumberedSortingInfo > SortingInfo;
  64 };
  65
  66 //=============================================================================
  67
  68 }; }; }; };
  69
  70 #endif