EMoneyResult.h

[詳解]

/// @file
/// @brief 電子マネー操作結果を提供するクラス EMoneyResult のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_EMONEYRESULT_H
#define AMDAEMON_EMONEYRESULT_H

#include "amdaemon/env.h"
#include "amdaemon/EMoneyResultStatus.h"
#include "amdaemon/EMoneyBrand.h"
#include "amdaemon/EMoneyDef.h"
#include "amdaemon/util/DateTime.h"

#include <cstdint>

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

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

    /// @brief 電子マネー操作結果を提供するクラス。
    /// @see EMoney, EMoneyOperation
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// EMoney クラスや EMoneyOperation クラスの各種メンバ関数から取得すること。
    ///
    /// @par 直近の操作結果
    /// - EMoneyOperation クラスのメンバ関数 EMoneyOperation#getResult から取得する。
    /// - 残高照会および支払の操作でのみ設定される。それ以外の操作では設定されない。
    /// - 操作に成功した場合、全メンバ関数が有効な値を返す。
    /// - 操作に失敗した場合、下記のメンバ関数のみ有効な値を返す。
    ///     - #valid
    ///     - #getStatus
    ///     - #getTime
    ///     - #getBrand
    ///     - #getDealNumber
    /// - メンバ関数 #getStatus は、操作に成功した場合は EMoneyResultStatus::Success を、
    ///   失敗した場合は EMoneyResultStatus::Fail を返す。
    ///
    /// @par 取引結果履歴
    /// - EMoney クラスのメンバ関数 EMoney#getDealResult 等から取得する。
    /// - 全メンバ関数が有効な値を返す。
    /// - メンバ関数 #getStatus の返す値は下記のように定まる。
    ///     - 支払操作中の電断等により支払が未了の場合は EMoneyResultStatus::Unconfirm 。
    ///     - 支払操作に失敗した場合は EMoneyResultStatus::Fail 。
    ///     - 支払操作に成功した場合は EMoneyResultStatus::Success 。
    ///     - 現実装で EMoneyResultStatus::Incomplete を返すことはない。
    class EMoneyResult
    {
    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit EMoneyResult(InnerIndexHolder);

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

        /// @brief 有効な情報が保持されているか否かを取得する。
        /// @retval true  有効な情報が保持されている場合。
        /// @retval false 有効な情報が保持されていない場合。
        bool valid() const;

        /// @brief 操作の最終状態を取得する。
        /// @return 操作の最終状態。
        ///
        /// 戻り値の詳細は EMoneyResult クラスの説明を参照すること。
        EMoneyResultStatus getStatus() const;

        /// @brief 操作日時を取得する。
        /// @return 操作日時。
        const ::amdaemon::util::DateTime& getTime() const;

        /// @brief 操作対象ブランド情報を取得する。
        /// @return 操作対象ブランド情報。
        const EMoneyBrand& getBrand() const { return _brand; }

        /// @brief 取引通番文字列を取得する。
        /// @return 取引通番文字列。
        ///
        /// 最大文字数は amdaemon::MaxEMoneyDealNumberLength 。終端文字を含まない。
        const wchar_t* getDealNumber() const;

        /// @brief カード番号の表示用文字列を取得する。
        /// @return カード番号の表示用文字列。操作中にエラーが発生した場合は不定値。
        ///
        /// 一部の文字が表示用にマスクされており、この値を識別子として用いることはできない。
        ///
        /// 最大文字数は amdaemon::MaxEMoneyCardNumberLength 。終端文字を含まない。
        const wchar_t* getCardNumber() const;

        /// @brief 取引金額を取得する。
        /// @return 取引金額。残高照会操作の場合や、操作中にエラーが発生した場合は 0 。
        std::int32_t getAmount() const;

        /// @brief 操作前の残高を取得する。
        /// @return 操作前の残高。操作中にエラーが発生した場合は 0 。
        std::int32_t getBalanceBefore() const;

        /// @brief 操作後の残高を取得する。
        /// @return 操作後の残高。操作中にエラーが発生した場合は 0 。
        ///
        /// 残高照会の結果はこの関数で取得できる。
        std::int32_t getBalanceAfter() const;

    private:
        std::size_t _ref;   ///< 内部参照値。
        EMoneyBrand _brand; ///< 操作対象ブランド情報。

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_EMONEYRESULT_H