1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __FRAMEWORK_LOADSTATE_H_
#define __FRAMEWORK_LOADSTATE_H_
//_________________________________________________________________________________________________________________
// includes
//_________________________________________________________________________________________________________________
#include <com/sun/star/ucb/InteractiveIOException.hpp>
#include <com/sun/star/ucb/InteractiveAugmentedIOException.hpp>
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
//_______________________________________________________________________
/**
These enum values specify all possible results of a load request.
It doesn't matter, if this load operation used dispatch() or loadComponentFromURL().
The meaning is everytime the same.
*/
enum ELoadState
{
E_UNSPECIFIED = 0, // indicates the operation was not already started
E_SUCCESS = 1, // the load request was successfull
E_IOERROR = 2, // there was an io error internaly
E_INTERACTION = 3, // there was an interaction, which couldn't be handled (doesn't include IO interactions => see E_IOERROR before)
E_FAILED = 4 // for unknown or unspecified errors
};
//_______________________________________________________________________
/**
Helper, which provides some functionality to identify the reason for
a failed load request and can describe it.
*/
class LoadStateHelper
{
public:
//_________________________________
/**
@short checks if the given interaction request was an io error
@descr This information can be used to throw
a suitable IOException. (e.g. loadComponentFromURL())
@param aRequest
the original interaction request, which may produced
the failed load request
@param rReason
in case this Method returns <TRUE/> the referred string object
will be used to set the original message of the
aborted io exception on it.
If method returns <FALSE/> rReason was not used.
@return [boolean]
<TRUE/> in case it was an IO error
<FALSE/> in case it wasn't an IO error or interaction was not used
*/
static sal_Bool wasIOError( const css::uno::Any& aRequest ,
rtl::OUString& rReason )
{
if ( ! aRequest.hasValue() )
return sal_False;
css::ucb::InteractiveIOException exIOInteractive ;
css::ucb::InteractiveAugmentedIOException exIOAugmented ;
if (aRequest>>=exIOInteractive)
{
rReason = exIOInteractive.Message;
return sal_True;
}
if (aRequest>>=exIOAugmented)
{
rReason = exIOAugmented.Message;
return sal_True;
}
return sal_False;
}
};
} // namespace framework
#endif // #ifndef __FRAMEWORK_LOADSTATE_H_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
