INTEGRATION: CWS cfgruggedised (1.1.2); FILE ADDED

2004/07/23 13:31:34 jb 1.1.2.1: #i28654#,#i29838# Add InteractionHandler support to configuration

1 files changed, 140 insertions, 0 deletions

diff --git a/configmgr/source/inc/simpleinteractionrequest.hxx b/configmgr/source/inc/simpleinteractionrequest.hxx
new file mode 100644
index 000000000000..7a140976a446
--- /dev/null
+++ b/configmgr/source/inc/simpleinteractionrequest.hxx
@@ -0,0 +1,140 @@
+/*************************************************************************
+ *
+ *  $RCSfile: simpleinteractionrequest.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2004-08-20 12:55:23 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library 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 for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef CONFIGMGR_SIMPLEINTERACTIONREQUEST_HXX
+#define CONFIGMGR_SIMPLEINTERACTIONREQUEST_HXX
+
+#ifndef CONFIGMGR_INTERACTIONREQUEST_HXX
+#include "interactionrequest.hxx"
+#endif
+
+// this file was copied and adapted from the corresponding file in module ucbhelper
+
+namespace configmgr {
+namespace apihelper {
+
+    namespace uno = com::sun::star::uno;
+/**
+    This class implements a simple interaction request. The user must not deal
+    with XInteractionContinuations directly, but can use constants that are
+    mapped internally to the according objects. This class encapsulates the
+    standard Interaction Continuations "Abort", "Retry", "Approve" and
+    "Disaprrove". Instances can be passed directly to
+    XInteractionHandler::handle(...).
+
+    @see InteractionRequest
+    @see InteractionAbort
+    @see InteractionRetry
+    @see InteractionApprove
+    @see InteractionDisapprove
+  */
+    class SimpleInteractionRequest : public InteractionRequest
+    {
+    public:
+        // type used to identify continuations
+        typedef sal_uInt32 Continuation;
+
+        /**
+        * Constructor.
+        *
+        * @param rRequest is the exception describing the error.
+        * @param nContinuations contains the possible "answers" for the request.
+        *        This can be any of the CONTINUATION_* constants combinations
+        *        listed above.
+        */
+        SimpleInteractionRequest( const uno::Any & rRequest,
+                                const Continuation nContinuations );
+
+        /**
+        * After passing this request to XInteractionHandler::handle, this method
+        * returns the continuation that was choosen by the interaction handler.
+        *
+        * @return the continuation choosen by an interaction handler or
+        *         CONTINUATION_UNKNOWN, if the request was not (yet) handled.
+        */
+        const Continuation getResponse() const;
+    };
+
+/** These are the constants that can be passed to the constructor of class
+  * SimpleInteractionRequest and that are returned by method
+  * SimpleInteractionRequest::getResponse().
+  */
+
+    /** The request was not (yet) handled by the interaction handler. */
+    const SimpleInteractionRequest::Continuation CONTINUATION_UNKNOWN    = 0;
+
+    /** The interaction handler selected XInteractionAbort. */
+    const SimpleInteractionRequest::Continuation CONTINUATION_ABORT      = 1;
+
+    /** The interaction handler selected XInteractionRetry. */
+    const SimpleInteractionRequest::Continuation CONTINUATION_RETRY      = 2;
+
+    /** The interaction handler selected XInteractionApprove. */
+    const SimpleInteractionRequest::Continuation CONTINUATION_APPROVE    = 4;
+
+    /** The interaction handler selected XInteractionDisapprove. */
+    const SimpleInteractionRequest::Continuation CONTINUATION_DISAPPROVE = 8;
+
+
+} // namespace apihelper
+} // namespace configmgr
+
+#endif /* !CONFIGMGR_SIMPLEINTERACTIONREQUEST_HXX */