xref: /aoo41x/main/framework/inc/jobs/jobconst.hxx (revision cdf0e10c)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef __FRAMEWORK_JOBS_JOBCONST_HXX_
29 #define __FRAMEWORK_JOBS_JOBCONST_HXX_
30 
31 //_______________________________________
32 // my own includes
33 
34 #include <stdtypes.h>
35 #include <general.h>
36 
37 //_______________________________________
38 // interface includes
39 
40 //_______________________________________
41 // other includes
42 
43 #include <rtl/ustring.hxx>
44 #include <fwidllapi.h>
45 
46 //_______________________________________
47 // namespace
48 
49 namespace framework{
50 
51 //_______________________________________
52 // public const
53 
54 //_______________________________________
55 /**
56     @short  defines all constant values used within a job environment.
57 
58     @descr  The protocol between job executor/dispatch and jobs is fix and well defined.
59             But why every implemented job should write such constant values directly into
60             it's code. Typos can occure or code will be changed by new developers ...
61             Shared set of constant values can help to improve the mentainance of this code.
62  */
63 class FWI_DLLPUBLIC JobConst
64 {
65     public:
66         static const ::rtl::OUString ANSWER_DEACTIVATE_JOB();
67         static const ::rtl::OUString ANSWER_SAVE_ARGUMENTS();
68         static const ::rtl::OUString ANSWER_SEND_DISPATCHRESULT();
69 };
70 
71 } // namespace framework
72 
73 #endif // __FRAMEWORK_JOBS_JOBCONST_HXX_
74