LibreOffice Module framework (master) 1
jobresult.hxx
Go to the documentation of this file.
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
27namespace framework{
28
35class JobResult final
36{
37
38 // types
39
40 public:
41
50 enum EParts
51 {
56 };
57
58 // member
59
60 private:
61
68 sal_uInt32 m_eParts;
69
76 std::vector< css::beans::NamedValue > m_lArguments;
77
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: */
represent a result of a finished job execution @descr Such result instance transport all necessary da...
Definition: jobresult.hxx:36
~JobResult()
standard dtor @descr Free all internally used resources at the end of living.
Definition: jobresult.cxx:131
sal_uInt32 m_eParts
an user of us must know, which (possible) parts of a "pure result" was really set by an executed job.
Definition: jobresult.hxx:68
std::vector< css::beans::NamedValue > getArguments() const
provides access to our internal members @descr The return value will be valid only in case a call of ...
Definition: jobresult.cxx:173
EParts
These enum values are used to build a flag mask of possible set parts of an analyzed pure job executi...
Definition: jobresult.hxx:51
JobResult(const css::uno::Any &aResult)
special ctor @descr It initialize this new instance with a pure job execution result and analyze it.
Definition: jobresult.cxx:72
JobResult & operator=(const JobResult &rCopy)
=operator @descr Must be implemented to overwrite this instance with another one.
Definition: jobresult.cxx:143
css::frame::DispatchResultEvent m_aDispatchResult
represent the part "DispatchResult" It's a fulfilled event type, which was given back by the executed...
Definition: jobresult.hxx:84
bool existPart(sal_uInt32 eParts) const
checks for existing parts of the analyzed result @descr The internal flag mask was set after analyzin...
Definition: jobresult.cxx:163
std::vector< css::beans::NamedValue > m_lArguments
a job can have persistent data They are part of the pure result and will be used to write it to the c...
Definition: jobresult.hxx:76
css::frame::DispatchResultEvent getDispatchResult() const
Definition: jobresult.cxx:175