offapi/com/sun/star/ucb/OpenCommandArgument2.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  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 .
  18  */
  19 #ifndef __com_sun_star_ucb_OpenCommandArgument2_idl__
  20 #define __com_sun_star_ucb_OpenCommandArgument2_idl__
  21
  22 #include <com/sun/star/ucb/OpenCommandArgument.idl>
  23 #include <com/sun/star/ucb/NumberedSortingInfo.idl>
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** The argument for commands like "open", "update", and "synchronize".
  29
  30     <p>This struct extends the original OpenCommandArgument, which must not be
  31     changed for compatibility reasons.
  32
  33     @see XCommandProcessor
  34 */
  35 published struct OpenCommandArgument2 : OpenCommandArgument
  36 {
  37     /** The sort criteria for the rows of the returned
  38         ContentResultSet.
  39
  40         <p>The result set implementation may ignore this parameter, if it
  41         cannot sort the data by the given criteria in an efficient way (i.e.
  42         directly using the underlying data source -> SQL-database -> ORDER BY).
  43     */
  44     sequence< com::sun::star::ucb::NumberedSortingInfo > SortingInfo;
  45 };
  46
  47
  48 }; }; }; };
  49
  50 #endif
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */