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