EMoneyReport.h

[詳解]

/// @file
/// @brief 電子マネー締め処理結果を提供するクラス EMoneyReport のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_EMONEYREPORT_H
#define AMDAEMON_EMONEYREPORT_H

#include "amdaemon/env.h"
#include "amdaemon/util/DateTime.h"

#include <cstdint>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_emoney
/// @{

    // 内部クラスの前方宣言
    class InnerIndexHolder;

    /// @brief 電子マネー締め処理結果を提供するクラス。
    /// @see EMoney
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// EMoney クラスのメンバ関数 EMoney#getReport 等から取得すること。
    ///
    /// 現状、締め処理対象ブランドは楽天Edyのみとなっている。
    /// 集計期間中に対象ブランドでの支払いが一度も行われていない場合、支払件数や支払総額が
    /// 0 となるが、正常な動作である。
    class EMoneyReport
    {
    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit EMoneyReport(InnerIndexHolder);

        // 下記は暗黙の定義を用いる。
        //‾EMoneyReport() = default;

        /// @brief 締め処理日時を取得する。
        /// @return 締め処理日時。
        const ::amdaemon::util::DateTime& getTime() const;

        /// @brief 締め処理が成功したか否かを取得する。
        /// @retval true  成功した場合。
        /// @retval false 失敗した場合。
        ///
        /// この関数が false を返す場合、下記メンバ関数はすべて 0 を返す。
        ///
        /// - #getCount
        /// - #getAmount
        /// - #getAlarmCount
        /// - #getAlarmAmount
        bool isSucceeded() const;

        /// @brief 支払件数を取得する。
        /// @return
        ///     支払件数。
        ///     締め処理対象ブランドでの支払が行われていないか、締め処理に失敗した場合は 0 。
        std::size_t getCount() const;

        /// @brief 支払総額を取得する。
        /// @return
        ///     支払総額。
        ///     締め処理対象ブランドでの支払が行われていないか、締め処理に失敗した場合は 0 。
        std::int32_t getAmount() const;

        /// @brief アラームが発生した支払件数を取得する。
        /// @return
        ///     アラームが発生した支払件数。
        ///     締め処理対象ブランドでの支払が行われていないか、アラームが発生していないか、
        ///     締め処理に失敗した場合は 0 。
        std::size_t getAlarmCount() const;

        /// @brief アラームが発生した支払総額を取得する。
        /// @return
        ///     アラームが発生した支払総額。
        ///     締め処理対象ブランドでの支払が行われていないか、アラームが発生していないか、
        ///     締め処理に失敗した場合は 0 。
        std::int32_t getAlarmAmount() const;

    private:
        std::size_t _index; ///< 締め処理結果インデックス。

    private:
        // コピー禁止
        EMoneyReport(const EMoneyReport&);              // 宣言のみ
        EMoneyReport& operator=(const EMoneyReport&);   // 宣言のみ
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_EMONEYREPORT_H