xref: /aoo41x/main/framework/inc/jobs/jobconst.hxx (revision f8e07b45)
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 __FRAMEWORK_JOBS_JOBCONST_HXX_
25 #define __FRAMEWORK_JOBS_JOBCONST_HXX_
26 
27 //_______________________________________
28 // my own includes
29 
30 #include <stdtypes.h>
31 #include <general.h>
32 
33 //_______________________________________
34 // interface includes
35 
36 //_______________________________________
37 // other includes
38 
39 #include <rtl/ustring.hxx>
40 #include <fwidllapi.h>
41 
42 //_______________________________________
43 // namespace
44 
45 namespace framework{
46 
47 //_______________________________________
48 // public const
49 
50 //_______________________________________
51 /**
52     @short  defines all constant values used within a job environment.
53 
54     @descr  The protocol between job executor/dispatch and jobs is fix and well defined.
55             But why every implemented job should write such constant values directly into
56             it's code. Typos can occure or code will be changed by new developers ...
57             Shared set of constant values can help to improve the mentainance of this code.
58  */
59 class FWI_DLLPUBLIC JobConst
60 {
61     public:
62         static const ::rtl::OUString ANSWER_DEACTIVATE_JOB();
63         static const ::rtl::OUString ANSWER_SAVE_ARGUMENTS();
64         static const ::rtl::OUString ANSWER_SEND_DISPATCHRESULT();
65 };
66 
67 } // namespace framework
68 
69 #endif // __FRAMEWORK_JOBS_JOBCONST_HXX_
70