configmgr/source/inc/simpleinteractionrequest.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: simpleinteractionrequest.hxx,v $
  10  * $Revision: 1.4.18.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef CONFIGMGR_SIMPLEINTERACTIONREQUEST_HXX
  32 #define CONFIGMGR_SIMPLEINTERACTIONREQUEST_HXX
  33
  34 #include "interactionrequest.hxx"
  35
  36 // this file was copied and adapted from the corresponding file in module ucbhelper
  37
  38 namespace configmgr {
  39 namespace apihelper {
  40
  41     namespace uno = com::sun::star::uno;
  42 /**
  43     This class implements a simple interaction request. The user must not deal
  44     with XInteractionContinuations directly, but can use constants that are
  45     mapped internally to the according objects. This class encapsulates the
  46     standard Interaction Continuations "Abort", "Retry", "Approve" and
  47     "Disaprrove". Instances can be passed directly to
  48     XInteractionHandler::handle(...).
  49
  50     @see InteractionRequest
  51     @see InteractionAbort
  52     @see InteractionRetry
  53     @see InteractionApprove
  54     @see InteractionDisapprove
  55   */
  56     class SimpleInteractionRequest : public InteractionRequest
  57     {
  58     public:
  59         /**
  60         * Constructor.
  61         *
  62         * @param rRequest is the exception describing the error.
  63         * @param nContinuations contains the possible "answers" for the request.
  64         *        This can be any of the CONTINUATION_* constants combinations
  65         *        listed above.
  66         */
  67         SimpleInteractionRequest( const uno::Any & rRequest,
  68                                 const sal_uInt32 nContinuations );
  69
  70         /**
  71         * After passing this request to XInteractionHandler::handle, this method
  72         * returns the continuation that was choosen by the interaction handler.
  73         *
  74         * @return the continuation choosen by an interaction handler or
  75         *         CONTINUATION_UNKNOWN, if the request was not (yet) handled.
  76         */
  77         sal_uInt32 getResponse() const;
  78     };
  79
  80 /** These are the constants that can be passed to the constructor of class
  81   * SimpleInteractionRequest and that are returned by method
  82   * SimpleInteractionRequest::getResponse().
  83   */
  84
  85     /** The request was not (yet) handled by the interaction handler. */
  86     const sal_uInt32 CONTINUATION_UNKNOWN    = 0;
  87
  88     /** The interaction handler selected XInteractionAbort. */
  89     const sal_uInt32 CONTINUATION_ABORT      = 1;
  90
  91     /** The interaction handler selected XInteractionRetry. */
  92     const sal_uInt32 CONTINUATION_RETRY      = 2;
  93
  94     /** The interaction handler selected XInteractionApprove. */
  95     const sal_uInt32 CONTINUATION_APPROVE    = 4;
  96
  97     /** The interaction handler selected XInteractionDisapprove. */
  98     const sal_uInt32 CONTINUATION_DISAPPROVE = 8;
  99
 100
 101 } // namespace apihelper
 102 } // namespace configmgr
 103
 104 #endif /* !CONFIGMGR_SIMPLEINTERACTIONREQUEST_HXX */