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 INCLUDED_FRAMEWORK_INC_JOBS_JOBRESULT_HXX
  21 #define INCLUDED_FRAMEWORK_INC_JOBS_JOBRESULT_HXX
  22
  23 #include <stdtypes.h>
  24 #include <general.h>
  25
  26 #include <com/sun/star/beans/NamedValue.hpp>
  27 #include <com/sun/star/frame/DispatchResultEvent.hpp>
  28
  29 #include <rtl/ustring.hxx>
  30
  31 namespace framework{
  32
  33 /**
  34     @short  represent a result of a finished job execution
  35     @descr  Such result instance transport all neccessarry
  36             data from the code place where the job was finished
  37             to the outside code, where e.g. listener must be notified.
  38  */
  39 class JobResult
  40 {
  41
  42     // types
  43
  44     public:
  45
  46         /**
  47             These enum values are used to build a flag mask of possible set
  48             parts of an analyzed pure job execution result.
  49             An user of this class can decide, if a member of us can be valid
  50             or not. So it can indicate, if a job used the special part inside
  51             his returned result protocol.
  52             To be usable as flags - it must be values of set {0,1,2,4,8,16 ...}!
  53          */
  54         enum EParts
  55         {
  56             E_NOPART            =   0,
  57             E_ARGUMENTS         =   1,
  58             E_DEACTIVATE        =   2,
  59             E_DISPATCHRESULT    =   4
  60         };
  61
  62     // member
  63
  64     private:
  65
  66         /** hold the original pure result, which was given back by an
  67             executed job
  68             We analyze it and use it to set all our other members.
  69          */
  70         css::uno::Any m_aPureResult;
  71
  72         /**
  73             an user of us must know, which (possible) parts of
  74             a "pure result" was really set by an executed job.
  75             Means which other members of this class are valid.
  76             This mask can be used to find it out.
  77          */
  78         sal_uInt32 m_eParts;
  79
  80         /**
  81             a job can have persistent data
  82             They are part of the pure result and will be used to
  83             write it to the configuration. But that's part of any
  84             user of us. We provide this information here only.
  85          */
  86         css::uno::Sequence< css::beans::NamedValue > m_lArguments;
  87
  88         /**
  89             an executed job can force his deactivation
  90             But we provide this information here only.
  91             Doing so is part of any user of us.
  92          */
  93         bool m_bDeactivate;
  94
  95         /**
  96             represent the part "DispatchResult"
  97             It's a full filled event type, which was given
  98             back by the executed job. Any user of us can send
  99             it to his registered result listener directly.
 100          */
 101         css::frame::DispatchResultEvent m_aDispatchResult;
 102
 103     // native interface
 104
 105     public:
 106
 107                  JobResult(                                         );
 108                  JobResult( const com::sun::star::uno::Any& aResult );
 109                  JobResult( const JobResult&                rCopy   );
 110         virtual ~JobResult(                                         );
 111
 112         void operator=( const JobResult& rCopy );
 113
 114         bool                                     existPart        ( sal_uInt32 eParts ) const;
 115         css::uno::Sequence< css::beans::NamedValue > getArguments     (                   ) const;
 116         css::frame::DispatchResultEvent              getDispatchResult(                   ) const;
 117 };
 118
 119 } // namespace framework
 120
 121 #endif // INCLUDED_FRAMEWORK_INC_JOBS_JOBRESULT_HXX
 122
 123 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */