1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_task_XInteractionRequestStringResolver_idl__
24#define __com_sun_star_task_XInteractionRequestStringResolver_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_beans_Optional_idl__
31#include <com/sun/star/beans/Optional.idl>
32#endif
33
34#ifndef __com_sun_star_task_XInteractionRequest_idl__
35#include <com/sun/star/task/XInteractionRequest.idl>
36#endif
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module task {
41
42//=============================================================================
43
44/** Obtains human readable strings from an <type>XInteractionRequest</type>.
45 */
46/* published */
47interface XInteractionRequestStringResolver : com::sun::star::uno::XInterface
48{
49    //-------------------------------------------------------------------------
50
51    /** Obtains a string containing a human readable message from an
52        informational interaction request.
53
54        <p>An informational interaction request contains not more than one
55        interaction continuation (user has no choice; request is just
56        informational). The supplies continuation must either be a
57        <type>XInteractionAbort</type> or <type>XInteractionApprove</type>
58
59        @param Request the interaction request for that the message shall
60        be obtained.
61
62        @returns the message string or an empty
63        <type scope="::com::sun::star::beans">Optional</type>.
64     */
65    com::sun::star::beans::Optional< string >
66        getStringFromInformationalRequest(
67	    [in] com::sun::star::task::XInteractionRequest Request );
68
69};
70
71//=============================================================================
72
73}; }; }; };
74
75/*=============================================================================
76
77=============================================================================*/
78#endif
79