offapi/com/sun/star/ucb/XContentIdentifierMapping.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_XContentIdentifierMapping_idl__
  20 #define __com_sun_star_ucb_XContentIdentifierMapping_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25 module com { module sun { module star { module ucb {
  26
  27  published interface XContent;
  28  published interface XContentIdentifier;
  29
  30 /** A mapping from a (source) set of XContentIdentifiers to
  31     another (target) set of XContentIdentifiers.
  32
  33     <p>For convenience and performance, mapping between the string
  34     representations of source/target XContentIdentifiers, as well as mapping
  35     between XContents identified by source/target
  36     XContentIdentifiers is also supported.
  37
  38     <p>This interface can be useful in cases where the identifiers (and
  39     associated contents) returned by the various methods of an
  40     XContentAccess need to be mapped to some other space of
  41     identifiers (and associated contents).
  42
  43     @see XContent
  44     @see XContentAccess
  45     @see XContentIdentifier
  46 */
  47
  48 published interface XContentIdentifierMapping: com::sun::star::uno::XInterface
  49 {
  50     /** Map the string representation of an XContentIdentifier.
  51
  52         @param Source  The string representation of an XContentIdentifier
  53         from the source set.
  54
  55         @returns  The string representation of the target set's
  56         XContentIdentifier corresponding to the source identifier.  The
  57         returned string may be empty if either Source was empty already, or if
  58         there's no applicable target to map to.
  59     */
  60     string mapContentIdentifierString([in] string Source);
  61
  62     /** Map an XContentIdentifier.
  63
  64         @param Source  An XContentIdentifier from the source set.
  65
  66         @returns  The target set's XContentIdentifier corresponding to the
  67         source identifier.  The returned XContentIdentifier may be null if
  68         either Source was null already, or if there's no applicable target to
  69         map to.
  70     */
  71     XContentIdentifier mapContentIdentifier([in] XContentIdentifier Source);
  72
  73     /** Map the XContent identified by an
  74         XContentIdentifier.
  75
  76         @param Source  The XContent identified by an XContentIdentifier from
  77         the source set.
  78
  79         @returns  The XContent identified by the target set's
  80         XContentIdentifier corresponding to the source identifier.  The
  81         returned XContent may be null if either Source was null already, or if
  82         there's no applicable target to map to.
  83     */
  84     XContent mapContent([in] XContent Source);
  85
  86     /** Map the content identifiers (or related data) contained in the columns
  87         of a com::sun::star::sdbc::XRow.
  88
  89         @param Value  On input, a sequence of anys corresponding to the columns
  90         of the XRow (the first column goes into the zeroth position of the
  91         sequence, and so on).  On output, the same sequence, but with the
  92         entries mapped as necessary.  This is an inout parameter rather than a
  93         combination of in parameter and return value for    performance reasons
  94         (assuming that in most cases most elements in the input sequence will
  95         be returned unmodified).
  96
  97         @returns  `TRUE` if any of the columns contain data that (potentially)
  98         needs mapping (though maybe no mapping occurred for the concrete input
  99         data of this call).  This information can be useful to decide whether,
 100         for another row, a call to this function is at all necessary.
 101     */
 102     boolean mapRow([inout] sequence< any > Value);
 103 };
 104
 105
 106 }; }; }; };
 107
 108 #endif
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */