framework/inc/jobs/jobconst.hxx

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