xref: /aoo4110/main/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_task_XInteractionRequestStringResolver_idl__
#define __com_sun_star_task_XInteractionRequestStringResolver_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_beans_Optional_idl__
#include <com/sun/star/beans/Optional.idl>
#endif

#ifndef __com_sun_star_task_XInteractionRequest_idl__
#include <com/sun/star/task/XInteractionRequest.idl>
#endif

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

 module com {  module sun {  module star {  module task {

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

/** Obtains human readable strings from an <type>XInteractionRequest</type>.
 */
/* published */
interface XInteractionRequestStringResolver : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** Obtains a string containing a human readable message from an
        informational interaction request.

        <p>An informational interaction request contains not more than one
        interaction continuation (user has no choice; request is just
        informational). The supplies continuation must either be a
        <type>XInteractionAbort</type> or <type>XInteractionApprove</type>

        @param Request the interaction request for that the message shall
        be obtained.

        @returns the message string or an empty
        <type scope="::com::sun::star::beans">Optional</type>.
     */
    com::sun::star::beans::Optional< string >
        getStringFromInformationalRequest(
	    [in] com::sun::star::task::XInteractionRequest Request );

};

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

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif