summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/OpenCommandArgument2.idl
blob: d942b8d9d5c90c4f0e47267faa2dfd198b793f7c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: OpenCommandArgument2.idl,v $
 * $Revision: 1.8 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_OpenCommandArgument2_idl__
#define __com_sun_star_ucb_OpenCommandArgument2_idl__

#ifndef __com_sun_star_ucb_OpenCommandArgument_idl__
#include <com/sun/star/ucb/OpenCommandArgument.idl>
#endif

#ifndef __com_sun_star_ucb_NumberedSortingInfo_idl__
#include <com/sun/star/ucb/NumberedSortingInfo.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** The argument for commands like "open", "update", and "synchronize".

    <p>This strcut extends the original OpenCommandArgument, which must not be
    changed for compatibility reasons.

    @see XCommandProcessor
*/
published struct OpenCommandArgument2 : OpenCommandArgument
{
    //-------------------------------------------------------------------------
    /** The sort criteria for the rows of the returned
        <type>ContentResultSet</type>.

        <p>The resultset implementation may ignore this parameter, if it
        cannot sort the data by the given criteria in an efficient way (i.e.
        directly using the underlying data source -> SQL-database -> ORDER BY).
    */
    sequence< com::sun::star::ucb::NumberedSortingInfo > SortingInfo;
};

//=============================================================================

}; }; }; };

#endif