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 
24 #ifndef _UCBHELPER_SIMPLEIOERRORREQUEST_HXX
25 #define _UCBHELPER_SIMPLEIOERRORREQUEST_HXX
26 
27 #include <com/sun/star/ucb/IOErrorCode.hpp>
28 #include <ucbhelper/interactionrequest.hxx>
29 
30 namespace com { namespace sun { namespace star { namespace ucb {
31     class XCommandProcessor;
32 } } } }
33 
34 namespace ucbhelper {
35 
36 /**
37   * This class implements a simple IO error interaction request. Instances
38   * can be passed directly to XInteractionHandler::handle(...). Each
39   * instance contains an InteractiveIOException and one interaction
40   * continuation: "Abort".
41   *
42   * @see com::sun::star::ucb::InteractiveIOException
43   * @see InteractionAbort
44   */
45 class SimpleIOErrorRequest : public ucbhelper::InteractionRequest
46 {
47 public:
48     /**
49       * Constructor.
50       *
51       * @param xContext contains the command processor that executes the
52       *        command related to the request.
53       *
54       * @param eError is the error code to pass along with the request.
55       *
56       * qparam rArgs are additional parameters according to the specification
57       *        of the error code. Refer to com/sun/star/ucb/IOErrorCode.idl
58       *        for details.
59 	  */
60     SimpleIOErrorRequest( const com::sun::star::ucb::IOErrorCode eError,
61                           const com::sun::star::uno::Sequence<
62                             com::sun::star::uno::Any > & rArgs,
63                           const rtl::OUString & rMessage,
64                           const com::sun::star::uno::Reference<
65                             com::sun::star::ucb::XCommandProcessor > & xContext
66                          );
67 };
68 
69 } // namespace ucbhelper
70 
71 #endif /* !_UCBHELPER_SIMPLEIOERRORREQUEST_HXX */
72