framework/inc/jobs/jobresult.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __FRAMEWORK_JOBS_JOBRESULT_HXX_
  21 #define __FRAMEWORK_JOBS_JOBRESULT_HXX_
  22
  23 #include <threadhelp/threadhelpbase.hxx>
  24 #include <macros/debug.hxx>
  25 #include <stdtypes.h>
  26 #include <general.h>
  27
  28 #include <com/sun/star/beans/NamedValue.hpp>
  29 #include <com/sun/star/frame/DispatchResultEvent.hpp>
  30
  31 #include <rtl/ustring.hxx>
  32
  33
  34 namespace framework{
  35
  36
  37 //_______________________________________
  38 /**
  39     @short  represent a result of a finished job execution
  40     @descr  Such result instance transport all neccessarry
  41             data from the code place where the job was finished
  42             to the outside code, where e.g. listener must be notified.
  43  */
  44 class JobResult : private ThreadHelpBase
  45 {
  46     //___________________________________
  47     // types
  48
  49     public:
  50
  51         /**
  52             These enum values are used to build a flag mask of possible set
  53             parts of an analyzed pure job execution result.
  54             An user of this class can decide, if a member of us can be valid
  55             or not. So it can indicate, if a job used the special part inside
  56             his returned result protocol.
  57             To be usable as flags - it must be values of set {0,1,2,4,8,16 ...}!
  58          */
  59         enum EParts
  60         {
  61             E_NOPART            =   0,
  62             E_ARGUMENTS         =   1,
  63             E_DEACTIVATE        =   2,
  64             E_DISPATCHRESULT    =   4
  65         };
  66
  67     //___________________________________
  68     // member
  69
  70     private:
  71
  72         /** hold the original pure result, which was given back by an
  73             executed job
  74             We analyze it and use it to set all our other members.
  75          */
  76         css::uno::Any m_aPureResult;
  77
  78         /**
  79             an user of us must know, which (possible) parts of
  80             a "pure result" was realy set by an executed job.
  81             Means which other members of this class are valid.
  82             This mask can be used to find it out.
  83          */
  84         sal_uInt32 m_eParts;
  85
  86         /**
  87             a job can have persistent data
  88             They are part of the pure result and will be used to
  89             write it to the configuration. But that's part of any
  90             user of us. We provide this information here only.
  91          */
  92         css::uno::Sequence< css::beans::NamedValue > m_lArguments;
  93
  94         /**
  95             an executed job can force his deactivation
  96             But we provide this information here only.
  97             Doing so is part of any user of us.
  98          */
  99         sal_Bool m_bDeactivate;
 100
 101         /**
 102             represent the part "DispatchResult"
 103             It's a full filled event type, which was given
 104             back by the executed job. Any user of us can send
 105             it to his registered result listener directly.
 106          */
 107         css::frame::DispatchResultEvent m_aDispatchResult;
 108
 109     //___________________________________
 110     // native interface
 111
 112     public:
 113
 114                  JobResult(                                         );
 115                  JobResult( const com::sun::star::uno::Any& aResult );
 116                  JobResult( const JobResult&                rCopy   );
 117         virtual ~JobResult(                                         );
 118
 119         void operator=( const JobResult& rCopy );
 120
 121         sal_Bool                                     existPart        ( sal_uInt32 eParts ) const;
 122         css::uno::Sequence< css::beans::NamedValue > getArguments     (                   ) const;
 123         css::frame::DispatchResultEvent              getDispatchResult(                   ) const;
 124 };
 125
 126 } // namespace framework
 127
 128 #endif // __FRAMEWORK_JOBS_JOBRESULT_HXX_
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */