opentxs::OTRecord Class Reference

#include <OTRecord.hpp>

Public Types
enum	OTRecordType {   Mail = 0, Transfer, Receipt, Instrument,   ErrorState }

Public Member Functions
EXPORT void	SetSpecialMail (bool bIsSpecial=true)
EXPORT bool	IsSpecialMail () const
EXPORT bool	IsPending () const
EXPORT bool	IsOutgoing () const
EXPORT bool	IsRecord () const
EXPORT bool	IsReceipt () const
EXPORT bool	IsMail () const
EXPORT bool	IsTransfer () const
EXPORT bool	IsCheque () const
EXPORT bool	IsInvoice () const
EXPORT bool	IsVoucher () const
EXPORT bool	IsContract () const
EXPORT bool	IsPaymentPlan () const
EXPORT bool	IsCash () const
EXPORT bool	HasContents () const
EXPORT bool	HasMemo () const
EXPORT bool	IsExpired () const
EXPORT bool	IsCanceled () const
EXPORT void	SetExpired ()
EXPORT void	SetCanceled ()
EXPORT time64_t	GetValidFrom () const
EXPORT time64_t	GetValidTo () const
EXPORT void	SetDateRange (time64_t tValidFrom, time64_t tValidTo)
EXPORT bool	CanDeleteRecord () const
EXPORT bool	CanAcceptIncoming () const
EXPORT bool	CanDiscardIncoming () const
EXPORT bool	CanCancelOutgoing () const
EXPORT bool	CanDiscardOutgoingCash () const
EXPORT bool	CancelOutgoing (std::string str_via_acct) const
EXPORT bool	AcceptIncomingInstrument (const std::string &str_into_acct) const
EXPORT bool	AcceptIncomingTransfer () const
EXPORT bool	AcceptIncomingReceipt () const
EXPORT bool	DiscardIncoming () const
EXPORT bool	DeleteRecord () const
EXPORT bool	DiscardOutgoingCash () const
EXPORT int32_t	GetBoxIndex () const
EXPORT void	SetBoxIndex (int32_t nBoxIndex)
EXPORT int32_t	GetMethodID () const
EXPORT void	SetMethodID (int32_t nMethodID)
EXPORT const std::string &	GetMsgID () const
EXPORT void	SetMsgID (const std::string &str_id)
EXPORT const std::string &	GetMsgType () const
EXPORT void	SetMsgType (const std::string &str_type)
EXPORT const std::string &	GetMsgTypeDisplay () const
EXPORT void	SetMsgTypeDisplay (const std::string &str_type)
EXPORT int64_t	GetTransactionNum () const
EXPORT void	SetTransactionNum (int64_t lTransNum)
EXPORT int64_t	GetTransNumForDisplay () const
EXPORT void	SetTransNumForDisplay (int64_t lTransNum)
EXPORT OTRecordType	GetRecordType () const
EXPORT const std::string &	GetServerID () const
EXPORT const std::string &	GetAssetID () const
EXPORT const std::string &	GetCurrencyTLA () const
EXPORT const std::string &	GetNymID () const
EXPORT const std::string &	GetAccountID () const
EXPORT const std::string &	GetAddress () const
EXPORT const std::string &	GetOtherNymID () const
EXPORT const std::string &	GetOtherAccountID () const
EXPORT const std::string &	GetOtherAddress () const
EXPORT const std::string &	GetName () const
EXPORT const std::string &	GetDate () const
EXPORT const std::string &	GetAmount () const
EXPORT const std::string &	GetInstrumentType () const
EXPORT const std::string &	GetMemo () const
EXPORT const std::string &	GetContents () const
EXPORT void	SetOtherNymID (const std::string &str_ID)
EXPORT void	SetOtherAccountID (const std::string &str_ID)
EXPORT void	SetAddress (const std::string &str_Address)
EXPORT void	SetOtherAddress (const std::string &str_Address)
EXPORT void	SetMemo (const std::string &str_memo)
EXPORT void	SetContents (const std::string &str_contents)
EXPORT bool	HasInitialPayment () const
EXPORT bool	HasPaymentPlan () const
EXPORT time64_t	GetInitialPaymentDate () const
EXPORT time64_t	GetPaymentPlanStartDate () const
EXPORT time64_t	GetTimeBetweenPayments () const
EXPORT int64_t	GetInitialPaymentAmount () const
EXPORT int64_t	GetPaymentPlanAmount () const
EXPORT int32_t	GetMaximumNoPayments () const
EXPORT bool	FormatAmount (std::string &str_output) const
EXPORT bool	FormatDescription (std::string &str_output) const
EXPORT bool	FormatShortMailDescription (std::string &str_output) const
EXPORT bool	FormatMailSubject (std::string &str_output) const
bool	operator< (const OTRecord &rhs)
	OTRecord (const std::string &str_server_id, const std::string &str_asset_id, const std::string &str_currency_tla, const std::string &str_nym_id, const std::string &str_account_id, const std::string &str_name, const std::string &str_date, const std::string &str_amount, const std::string &str_type, bool bIsPending, bool bIsOutgoing, bool bIsRecord, bool bIsReceipt, OTRecordType eRecordType)

Detailed Description

Definition at line 141 of file OTRecord.hpp.

Member Enumeration Documentation

enum opentxs::OTRecord::OTRecordType

Enumerator
Mail
Transfer
Receipt
Instrument
ErrorState

Definition at line 144 of file OTRecord.hpp.

{ Mail = 0, Transfer, Receipt, Instrument, ErrorState };

Constructor & Destructor Documentation

opentxs::OTRecord::OTRecord	(	const std::string &	str_server_id,
		const std::string &	str_asset_id,
		const std::string &	str_currency_tla,
		const std::string &	str_nym_id,
		const std::string &	str_account_id,
		const std::string &	str_name,
		const std::string &	str_date,
		const std::string &	str_amount,
		const std::string &	str_type,
		bool	bIsPending,
		bool	bIsOutgoing,
		bool	bIsRecord,
		bool	bIsReceipt,
		OTRecordType	eRecordType
	)

Definition at line 1389 of file OTRecord.cpp.

    : m_nBoxIndex(-1)
    , m_ValidFrom(OT_TIME_ZERO)
    , m_ValidTo(OT_TIME_ZERO)
    , m_str_server_id(str_server_id)
    , m_str_asset_id(str_asset_id)
    , m_str_currency_tla(str_currency_tla)
    , m_str_nym_id(str_nym_id)
    , m_str_account_id(str_account_id)
    , m_str_name(str_name)
    , m_str_date(str_date)
    , m_str_amount(str_amount)
    , m_str_type(str_type)
    , m_bIsSpecialMail(false)
    , m_nMethodID(0)
    , m_lTransactionNum(0)
    , m_lTransNumForDisplay(0)
    , m_bIsPending(bIsPending)
    , m_bIsOutgoing(bIsOutgoing)
    , m_bIsRecord(bIsRecord)
    , m_bIsReceipt(bIsReceipt)
    , m_bIsPaymentPlan(false)
    , m_bIsSmartContract(false)
    , m_bIsVoucher(false)
    , m_bIsCheque(false)
    , m_bIsInvoice(false)
    , m_bIsCash(false)
    , m_bIsExpired(false)
    , m_bIsCanceled(false)
    , m_RecordType(eRecordType)
{
}

Member Function Documentation

bool opentxs::OTRecord::AcceptIncomingInstrument

(

const std::string &

str_into_acct

)

const

Definition at line 854 of file OTRecord.cpp.

{
    if (!CanAcceptIncoming()) return false;

    switch (GetRecordType()) {
    // Accept from Nym's payments inbox.
    //
    case OTRecord::Instrument: {
        if (m_str_server_id.empty() || m_str_nym_id.empty()) {
            otErr << __FUNCTION__ << ": Error: missing server id ("
                  << m_str_server_id << ") or nym id (" << m_str_nym_id
                  << ")\n";
            return false;
        }
        if (0 == m_lTransactionNum) {
            otErr << __FUNCTION__
                  << ": Error: Transaction number is 0, in payment "
                     "inbox for server id (" << m_str_server_id << "), nym id ("
                  << m_str_nym_id << ")\n";
            return false;
        }
        const OTIdentifier theServerID(m_str_server_id), theNymID(m_str_nym_id);

        // Open the Nym's payments inbox.
        OTLedger* pInbox =
            OTAPI_Wrap::OTAPI()->LoadPaymentInbox(theServerID, theNymID);
        std::unique_ptr<OTLedger> theInboxAngel(pInbox);
        if (nullptr == pInbox) {
            otErr << __FUNCTION__
                  << ": Error: Unable to load payment inbox for server "
                     "id (" << m_str_server_id << "), nym id (" << m_str_nym_id
                  << ")\n";
            return false;
        }
        // Find the payment therein that correlates to this OTRecord.
        //
        int nIndex = pInbox->GetTransactionIndex(m_lTransactionNum);

        if ((-1) == nIndex) {
            otErr << __FUNCTION__ << ": Error: Unable to find transaction "
                  << m_lTransactionNum << " in "
                                          "payment inbox for server id ("
                  << m_str_server_id << "), nym id (" << m_str_nym_id << ")\n";
            return false;
        }
        // Accept it.
        //
        OTString strIndices;
        strIndices.Format("%d", nIndex);
        const std::string str_indices(strIndices.Get());

        OT_ME madeEasy;
        if (!madeEasy.accept_from_paymentbox(str_into_acct, str_indices,
                                             "ANY")) {
            otErr << __FUNCTION__
                  << ": Error while trying to accept this instrument.\n";
            return false;
        }
    } // case: instrument
    break;
    default:
        otErr << __FUNCTION__ << ": Unexpected type: " << GetInstrumentType()
              << "\n";
        return false;
    }

    return true;
}

bool opentxs::OTRecord::AcceptIncomingReceipt

(

)

const

Definition at line 780 of file OTRecord.cpp.

{
    return AcceptIncomingTransferOrReceipt();
} // For incoming, (not-yet-accepted) receipts.

bool opentxs::OTRecord::AcceptIncomingTransfer

(

)

const

Definition at line 776 of file OTRecord.cpp.

{
    return AcceptIncomingTransferOrReceipt();
} // For incoming, pending (not-yet-accepted) transfers.

bool opentxs::OTRecord::CanAcceptIncoming

(

)

const

Definition at line 546 of file OTRecord.cpp.

{
    // Commented out because a transferReceipt is in the inbox, but it
    // represents an outgoing payment.
    //    if (IsOutgoing()) // If it's outgoing, then it's definitely not
    // an incoming thing you can accept.
    //        return false;

    if (IsRecord()) // Records must be archived or deleted, not accepted
                    // or discarded.
        return false;

    if (IsExpired()) return false;

    if (IsReceipt()) // It's NOT a record... If it's a receipt, then yes,
                     // we can accept it.
        return true;

    if (IsMail()) // Can't "accept" mail, can only delete it.
        return false;

    if (IsPending() && IsOutgoing()) // It's not a record, it's not
                                     // a receipt. If it's pending,
                                     // is it Outgoing pending? (Can
                                     // only accept INCOMING
                                     // pending, not outgoing.)
        return false;

    return true;
}

bool opentxs::OTRecord::CanCancelOutgoing

(

)

const

Definition at line 618 of file OTRecord.cpp.

{
    if (!IsOutgoing()) return false;

    if (IsCanceled()) // It's already canceled!
        return false;

    if (!IsPending()) return false;

    if (IsMail()) return false;

    if (IsRecord()) // This may be superfluous given the above 'if'
                    // pending.
        return false;

    if (IsReceipt()) // Receipts can't be canceled. (Probably
                     // superfluous.)
        return false;

    if (OTRecord::Transfer == GetRecordType()) // All outgoing, pending
                                               // instruments EXCEPT
                                               // transfer can be
                                               // canceled.
        return false;

    return true;
}

bool opentxs::OTRecord::CancelOutgoing

(

std::string

str_via_acct

)

const

Definition at line 1016 of file OTRecord.cpp.

{
    if (!CanCancelOutgoing()) return false;

    switch (GetRecordType()) {
    case OTRecord::Instrument: {
        if (m_str_nym_id.empty()) {
            otErr << __FUNCTION__ << ": Error: missing nym id (" << m_str_nym_id
                  << ")\n";
            return false;
        }

        const OTIdentifier theNymID(m_str_nym_id);
        std::string str_using_acct;

        if (IsCheque()) {
            str_using_acct = m_str_account_id;
        }
        else {
            str_using_acct = str_via_acct;
        }
        if (str_using_acct.empty()) {
            otErr << __FUNCTION__ << ": Error: Missing account ID (FAILURE)\n";
            return false;
        }
        if (0 == m_lTransactionNum) {
            if (IsCash()) {
                // Maybe it's cash...
                std::string strOutpayment(
                    OTAPI_Wrap::GetNym_OutpaymentsContentsByIndex(
                        m_str_nym_id, GetBoxIndex()));

                if (strOutpayment.empty()) {
                    int32_t lIndex = GetBoxIndex();
                    otErr << __FUNCTION__
                          << ": Error: Blank outpayment at index " << lIndex
                          << "\n";
                    return false;
                }
                OTString strPayment(strOutpayment);
                OTPayment thePayment(strPayment);

                if (!thePayment.IsValid() || !thePayment.SetTempValues()) {
                    int32_t lIndex = GetBoxIndex();
                    otErr << __FUNCTION__
                          << ": Error: Invalid outpayment at index " << lIndex
                          << "\n";
                    return false;
                }
                int64_t lTransNum = 0;
                thePayment.GetOpeningNum(lTransNum, theNymID);
                if (0 == lTransNum) // Found it.
                {
                    int32_t lIndex = GetBoxIndex();
                    OTString strIndices;
                    strIndices.Format("%d", lIndex);
                    const std::string str_indices(strIndices.Get());
                    OT_ME madeEasy;

                    return madeEasy.cancel_outgoing_payments(
                        m_str_nym_id, str_using_acct, str_indices);
                }
                else {
                    otErr << __FUNCTION__
                          << ": Error: Transaction number is non-zero ("
                          << lTransNum
                          << "), for cash outgoing payment for nym id ("
                          << m_str_nym_id << ")\n";
                    return false;
                }
            } // IsCash()
            else {
                otErr << __FUNCTION__ << ": Error: Transaction number is 0, "
                                         "for non-cash outgoing payment for "
                                         "nym id (" << m_str_nym_id << ")\n";
                return false;
            }
        }
        // Find the payment in the Nym's outpayments box that correlates to this
        // OTRecord.
        //
        int32_t nCount = OTAPI_Wrap::GetNym_OutpaymentsCount(m_str_nym_id);

        for (int32_t nIndex = 0; nIndex < nCount; ++nIndex) {
            std::string strOutpayment(
                OTAPI_Wrap::GetNym_OutpaymentsContentsByIndex(m_str_nym_id,
                                                              nIndex));

            if (strOutpayment.empty()) {
                otErr << __FUNCTION__ << ": Error: Blank outpayment at index "
                      << nIndex << "\n";
                return false;
            }
            OTString strPayment(strOutpayment);
            OTPayment thePayment(strPayment);

            if (!thePayment.IsValid() || !thePayment.SetTempValues()) {
                otErr << __FUNCTION__ << ": Error: Invalid outpayment at index "
                      << nIndex << "\n";
                return false;
            }
            int64_t lTransNum = 0;
            thePayment.GetOpeningNum(lTransNum, theNymID);
            if (lTransNum == m_lTransactionNum) // Found it.
            {
                OTString strIndices;
                strIndices.Format("%d", nIndex);
                const std::string str_indices(strIndices.Get());
                OT_ME madeEasy;

                return madeEasy.cancel_outgoing_payments(
                    m_str_nym_id, str_using_acct, str_indices);
            }
        } // for
    } break;
    default:
        otErr << __FUNCTION__ << ": Unexpected type: " << GetInstrumentType()
              << "\n";
        return false;
    }

    return true;
}

bool opentxs::OTRecord::CanDeleteRecord

(

)

const

Definition at line 532 of file OTRecord.cpp.

{
    if (IsMail()) return true;

    if (!IsRecord()) return false;

    if (IsPending()) // This may be superfluous given the above 'if'
                     // statement.
        return false;

    return true;
}

bool opentxs::OTRecord::CanDiscardIncoming

(

)

const

Definition at line 578 of file OTRecord.cpp.

{
    if (IsOutgoing()) return false;

    if (!IsPending()) return false;

    if (IsMail()) return false;

    if (IsRecord()) // This may be superfluous given the above 'if'
                    // pending.
        return false;

    if (IsReceipt()) // Receipts must be accepted, not discarded.
        return false;

    if (OTRecord::Transfer == GetRecordType()) // All incoming, pending
                                               // instruments EXCEPT
                                               // transfer can be
                                               // discarded.
        return false;

    return true;
}

bool opentxs::OTRecord::CanDiscardOutgoingCash

(

)

const

Definition at line 601 of file OTRecord.cpp.

{
    if (!IsOutgoing()) return false;

    if (!IsPending()) return false;

    if (!IsCash()) return false;

    if (!(GetBoxIndex() >= 0)) return false;

    return true;
}

bool opentxs::OTRecord::DeleteRecord

(

)

const

Definition at line 655 of file OTRecord.cpp.

{
    if (!CanDeleteRecord()) return false;
    if (!m_bIsSpecialMail &&
        (m_str_server_id.empty() || m_str_nym_id.empty())) {
        otErr << __FUNCTION__ << ": Error: missing server id ("
              << m_str_server_id << ") or nym id (" << m_str_nym_id << ")\n";
        return false;
    }
    std::string str_using_account;

    if ((OTRecord::Transfer == GetRecordType()) ||
        (OTRecord::Receipt == GetRecordType())) {
        if (m_str_account_id.empty()) {
            otErr << __FUNCTION__
                  << ": Error: missing account id for transfer or receipt.\n";
            return false;
        }

        str_using_account = m_str_account_id;
    }
    else
        str_using_account = m_str_nym_id; // For instruments.
    switch (GetRecordType()) {
    // Delete from in-mail or out-mail.
    //
    case OTRecord::Mail: {
        // If it's a Bitmessage or any other "non-OT" mail, then we can't
        // delete it here. We have to assume the client application is
        // smart enough to check for this and perform the deletion itself.
        // (Not all client apps will even support forms of mail other than
        // OT mail.)
        //
        if (!m_bIsSpecialMail) {
            if (m_bIsOutgoing) // outgoing mail
            {
                int32_t nCount = OTAPI_Wrap::GetNym_OutmailCount(m_str_nym_id);
                for (int32_t nIndex = 0; nIndex < nCount; ++nIndex) {
                    const std::string str_contents(
                        OTAPI_Wrap::GetNym_OutmailContentsByIndex(m_str_nym_id,
                                                                  nIndex));

                    if (str_contents == m_str_contents) // found it.
                    {
                        return OTAPI_Wrap::Nym_RemoveOutmailByIndex(
                            m_str_nym_id, nIndex);
                    }
                }
            }
            else // incoming mail
            {
                int32_t nCount = OTAPI_Wrap::GetNym_MailCount(m_str_nym_id);
                for (int32_t nIndex = 0; nIndex < nCount; ++nIndex) {
                    const std::string str_contents(
                        OTAPI_Wrap::GetNym_MailContentsByIndex(m_str_nym_id,
                                                               nIndex));

                    if (str_contents == m_str_contents) // found it.
                    {
                        return OTAPI_Wrap::Nym_RemoveMailByIndex(m_str_nym_id,
                                                                 nIndex);
                    }
                }
            }
        }
        else
            return true;

        return false;
    } break;
    case OTRecord::Transfer:   // Delete from asset account recordbox.
    case OTRecord::Receipt:    // Delete from asset account recordbox.
    case OTRecord::Instrument: // Delete from Nym's recordbox.
        break;
    default:
        otErr << __FUNCTION__ << ": Unexpected type: " << GetInstrumentType()
              << "\n";
        return false;
    }
    // The below section handles both the Nym's recordbox AND the Asset Account
    // recordbox.
    //
    if (0 == m_lTransactionNum) {
        otErr << __FUNCTION__
              << ": Error: Transaction number is 0, in recordbox for "
                 "server id (" << m_str_server_id << "), nym id ("
              << m_str_nym_id << "), acct id (" << str_using_account << ")\n";
        return false;
    }
    const OTIdentifier theServerID(m_str_server_id), theNymID(m_str_nym_id),
        theAcctID(str_using_account); // this last one sometimes contains NymID
                                      // (see above.)

    OTLedger* pRecordbox =
        OTAPI_Wrap::OTAPI()->LoadRecordBox(theServerID, theNymID, theAcctID);
    std::unique_ptr<OTLedger> theRecordBoxAngel(pRecordbox);
    if (nullptr == pRecordbox) {
        otErr << __FUNCTION__ << ": Failed loading record box for server ID ("
              << m_str_server_id << ") nymID "
                                    "(" << m_str_nym_id << ") accountID ("
              << str_using_account << ")\n";
        return false;
    }
    // Find the receipt in the recordbox that correlates to this OTRecord.
    //
    int nIndex = pRecordbox->GetTransactionIndex(m_lTransactionNum);

    if ((-1) == nIndex) {
        otErr << __FUNCTION__ << ": Error: Unable to find transaction "
              << m_lTransactionNum << " in recordbox "
                                      "for server id (" << m_str_server_id
              << "), nym id (" << m_str_nym_id << "), acct id ("
              << str_using_account << ")\n";
        return false;
    }
    // Accept it.
    //
    return OTAPI_Wrap::ClearRecord(
        m_str_server_id, m_str_nym_id, str_using_account, nIndex,
        false); // clear all = false. We're only clearing one record.
}

bool opentxs::OTRecord::DiscardIncoming

(

)

const

Definition at line 924 of file OTRecord.cpp.

{
    if (!CanDiscardIncoming()) return false;

    switch (GetRecordType()) {
    case OTRecord::Instrument: {
        if (m_str_server_id.empty() || m_str_nym_id.empty()) {
            otErr << __FUNCTION__ << ": Error: missing server id ("
                  << m_str_server_id << ") or nym id (" << m_str_nym_id
                  << ")\n";
            return false;
        }
        if (0 == m_lTransactionNum) {
            otErr << __FUNCTION__ << ": Error: Transaction number is 0, in "
                                     "payment inbox for server id ("
                  << m_str_server_id << "), nym id (" << m_str_nym_id << ")\n";
            return false;
        }
        const OTIdentifier theServerID(m_str_server_id), theNymID(m_str_nym_id);

        // Open the Nym's payments inbox.
        OTLedger* pInbox =
            OTAPI_Wrap::OTAPI()->LoadPaymentInbox(theServerID, theNymID);
        std::unique_ptr<OTLedger> theInboxAngel(pInbox);
        if (nullptr == pInbox) {
            otErr << __FUNCTION__
                  << ": Error: Unable to load payment inbox for server id ("
                  << m_str_server_id << "), nym id (" << m_str_nym_id << ")\n";
            return false;
        }
        // Find the payment therein that correlates to this OTRecord.
        //
        int nIndex = pInbox->GetTransactionIndex(m_lTransactionNum);

        if ((-1) == nIndex) {
            otErr << __FUNCTION__ << ": Error: Unable to find transaction "
                  << m_lTransactionNum << " in "
                                          "payment inbox for server id ("
                  << m_str_server_id << "), nym id (" << m_str_nym_id << ")\n";
            return false;
        }
        // Accept it.
        //
        OTString strIndices;
        strIndices.Format("%d", nIndex);
        const std::string str_indices(strIndices.Get());

        OT_ME madeEasy;

        return madeEasy.discard_incoming_payments(m_str_server_id, m_str_nym_id,
                                                  str_indices);

    } // case: instrument
    break;
    default:
        otErr << __FUNCTION__ << ": Unexpected type: " << GetInstrumentType()
              << "\n";
        return false;
    }

    return true;
}

bool opentxs::OTRecord::DiscardOutgoingCash

(

)

const

Definition at line 646 of file OTRecord.cpp.

{
    if (!CanDiscardOutgoingCash()) return false;
    return OTAPI_Wrap::Nym_RemoveOutpaymentsByIndex(m_str_nym_id,
                                                    GetBoxIndex());
}

bool opentxs::OTRecord::FormatAmount

(

std::string &

str_output

)

const

Definition at line 153 of file OTRecord.cpp.

{
    if (m_str_amount.empty() ||
        m_str_asset_id.empty()) // Need these to do the formatting.
    {
        //      otOut << __FUNCTION__ << ": Unable to format amount. Type: " <<
        // m_str_type << " Amount:
        // " << m_str_amount << "  Asset: " << m_str_asset_id << "";
        return false;
    }
    str_output = OTAPI_Wrap::It()->FormatAmount(
        m_str_asset_id, OTAPI_Wrap::It()->StringToLong(m_str_amount));
    return (!str_output.empty());
}

bool opentxs::OTRecord::FormatDescription

(

std::string &

str_output

)

const

Definition at line 235 of file OTRecord.cpp.

{
    OTString strDescription, strStatus, strKind;

    if (IsRecord()) {
        if (IsExpired())
            strStatus = "(EXPIRED)"; // How to tell difference between
                                     // instrument that processed successfully
                                     // and THEN expired, versus one that
                                     // expired before processing successfully?
                                     // (See next comment.)
        else if (IsInvoice())
            strStatus = "(payment sent)"; // TODO: need an "invalid records" box
                                          // for expired and canceled. Otherwise
                                          // we may falsely assume "payment
                                          // sent" when actually it expired. (We
                                          // may also falsely assume payment
                                          // expired when actually it was sent.)
                                          // Solution is a new box.
        else
            strStatus = "";
        //          strStatus = "(record)";
    }
    else if (IsPending()) {
        if (IsExpired())
            strStatus = "(EXPIRED)";
        else if (IsInvoice())
            strStatus = "(unpaid)";
        else if (!IsCash())
            strStatus = "(pending)";
    }
    if (IsCanceled()) {
        strStatus = "(CANCELED)";

        if (IsOutgoing() || IsReceipt()) strKind.Format("%s", "sent ");
    }
    else {
        if (IsOutgoing())
            strKind.Format(
                "%s", ((IsPending() && !IsCash()) ? "outgoing " : "sent "));
        else // incoming.
            strKind.Format("%s", IsPending()
                                     ? "incoming "
                                     : (IsReceipt() ? "" : "received "));
    }
    OTString strTransNumForDisplay;

    if (!IsCash())
        strTransNumForDisplay.Format(" #%ld", GetTransNumForDisplay());
    if (IsRecord()) {
        if (IsTransfer())
            strDescription.Format("%s%s%s %s", strKind.Get(), "transfer",
                                  strTransNumForDisplay.Get(), strStatus.Get());
        else if (IsVoucher())
            strDescription.Format("%s%s%s %s", strKind.Get(), "payment",
                                  strTransNumForDisplay.Get(), strStatus.Get());
        else if (IsReceipt()) {
            std::string str_instrument_type;

            if (0 == GetInstrumentType().compare("transferReceipt"))
                str_instrument_type = "transfer";
            else if (0 == GetInstrumentType().compare("finalReceipt"))
                str_instrument_type = "final receipt (closed)";
            else if (0 == GetInstrumentType().compare("marketReceipt")) {
                const int64_t lAmount =
                    OTAPI_Wrap::It()->StringToLong(m_str_amount);

                // I *think* successful trades have a negative amount -- we'll
                // find out!
                //
                if (lAmount == 0)
                    str_instrument_type = "failed trade";
                else {
                    str_instrument_type = "market trade (receipt)";
                }
            }
            else if (0 == GetInstrumentType().compare("chequeReceipt")) {
                const int64_t lAmount =
                    OTAPI_Wrap::It()->StringToLong(m_str_amount);

                // I paid OUT when this chequeReceipt came through. It must be a
                // normal cheque that I wrote.
                if (lAmount <= 0) // Notice less than OR EQUAL TO 0 -- that's
                                  // because a canceled cheque has a 0 value.
                    str_instrument_type = "cheque";
                else // I GOT PAID when this chequeReceipt came through. It must
                     // be an invoice I wrote, that someone paid.
                {
                    if (IsCanceled())
                        str_instrument_type = "invoice";
                    else
                        str_instrument_type = "invoice (payment received)";
                }
            }
            else if (0 == GetInstrumentType().compare("voucherReceipt")) {
                str_instrument_type = "payment";
            }
            else if (0 == GetInstrumentType().compare("paymentReceipt")) {
                const int64_t lAmount =
                    OTAPI_Wrap::It()->StringToLong(m_str_amount);

                if (!IsCanceled() && (lAmount > 0)) strKind.Set("received ");

                str_instrument_type = "recurring payment";
            }

            strDescription.Format("%s%s%s %s", strKind.Get(),
                                  str_instrument_type.c_str(),
                                  strTransNumForDisplay.Get(), strStatus.Get());
        }
        else
            strDescription.Format("%s%s%s %s", strKind.Get(),
                                  GetInstrumentType().c_str(),
                                  strTransNumForDisplay.Get(), strStatus.Get());
    }
    else {
        if (IsTransfer())
            strDescription.Format("%s %s%s%s", strStatus.Get(), strKind.Get(),
                                  "transfer", strTransNumForDisplay.Get());
        else if (IsVoucher())
            strDescription.Format("%s %s%s%s", strStatus.Get(), strKind.Get(),
                                  "payment", strTransNumForDisplay.Get());

        else if (IsReceipt()) {
            std::string str_instrument_type;

            if (0 == GetInstrumentType().compare("transferReceipt")) {
                if (IsCanceled())
                    str_instrument_type = "transfer";
                else
                    str_instrument_type = "transfer (receipt)";
            }
            else if (0 == GetInstrumentType().compare("finalReceipt"))
                str_instrument_type = "final receipt";
            else if (0 == GetInstrumentType().compare("marketReceipt")) {
                const int64_t lAmount =
                    OTAPI_Wrap::It()->StringToLong(m_str_amount);

                // I *think* marketReceipts have negative value. We'll just test
                // for non-zero.
                if (lAmount == 0)
                    str_instrument_type = "failed trade";
                else
                    str_instrument_type = "market trade (receipt)";
            }
            else if (0 == GetInstrumentType().compare("chequeReceipt")) {
                const int64_t lAmount =
                    OTAPI_Wrap::It()->StringToLong(m_str_amount);

                // I paid OUT when this chequeReceipt came through. It must be a
                // normal cheque that I wrote.
                if (lAmount <= 0) // Notice less than OR EQUAL TO 0 -- that's
                                  // because a canceled cheque has a 0 value.
                {
                    if (IsCanceled())
                        str_instrument_type = "cheque";
                    else
                        str_instrument_type = "cheque (receipt)";
                }
                else // I GOT PAID when this chequeReceipt came through. It
                       // must be an invoice I wrote, that someone paid.
                {
                    if (IsCanceled())
                        str_instrument_type = "invoice";
                    else
                        str_instrument_type =
                            "sent invoice (receipt: payment received)";
                }
            }
            else if (0 == GetInstrumentType().compare("voucherReceipt")) {
                if (IsCanceled())
                    str_instrument_type = "payment";
                else
                    str_instrument_type = "payment (receipt)";
            }
            else if (0 == GetInstrumentType().compare("paymentReceipt")) {
                const int64_t lAmount =
                    OTAPI_Wrap::It()->StringToLong(m_str_amount);

                if (!IsCanceled() && (lAmount > 0)) strKind.Set("received ");

                str_instrument_type = "recurring payment (receipt)";
            }

            strDescription.Format("%s %s%s%s", strStatus.Get(), strKind.Get(),
                                  str_instrument_type.c_str(),
                                  strTransNumForDisplay.Get());
        }
        else
            strDescription.Format("%s %s%s%s", strStatus.Get(), strKind.Get(),
                                  GetInstrumentType().c_str(),
                                  strTransNumForDisplay.Get());
    }
    str_output = strDescription.Get();
    return (!str_output.empty());
}

bool opentxs::OTRecord::FormatMailSubject

(

std::string &

str_output

)

const

Definition at line 167 of file OTRecord.cpp.

{
    str_output.clear();
    if (IsMail()) {
        if (!HasContents())
            str_output = "(empty subject)";
        else {
            std::string str_temp_contents = GetContents();

            if (str_temp_contents.compare(0, 8, "Subject:") == 0) {
                // Make the replacement.
                str_temp_contents.replace(0, 8, "");
            }
            // Trim it, since there is probably a space after "Subject:"
            // (Plus we want it trimmed anyway.)
            std::string str_contents = OTString::trim(str_temp_contents);
            // Cut the string at the first newline.
            //
            std::string::size_type pos_start = 0;
            std::string::size_type pos = str_contents.find("\r\n", pos_start);

            if (std::string::npos == pos) // Didn't find anything.
                pos = str_contents.find("\n", pos_start);
            if (std::string::npos != pos) // We found a newline.
                str_contents.erase(pos, std::string::npos);
            // Trim it again, just for good measure.
            str_output = OTString::trim(str_contents);
        }
    }
    return (!str_output.empty());
}

bool opentxs::OTRecord::FormatShortMailDescription

(

std::string &

str_output

)

const

Definition at line 198 of file OTRecord.cpp.

{
    OTString strDescription;

    if (IsMail()) {
        if (!HasContents())
            strDescription.Set("(empty message)");
        else {
            std::string str_temp_contents = GetContents();
            std::string str_contents = OTString::trim(str_temp_contents);

            if (str_contents.compare(0, 8, "Subject:") == 0) {
                // Make the replacement.
                str_contents.replace(0, 8, "");
            }
            bool bTruncated = false;

            if (str_contents.size() > 30) {
                str_contents.erase(30, std::string::npos);
                bTruncated = true;
            }
            // Replace any newlines with spaces...
            //
            std::replace(str_contents.begin(), str_contents.end(), '\r', ' ');
            std::replace(str_contents.begin(), str_contents.end(), '\n', ' ');

            //          str_contents.erase(std::remove(str_contents.begin(),
            // str_contents.end(), '\n'), str_contents.end());
            //          str_contents.erase(std::remove(str_contents.begin(),
            // str_contents.end(), '\r'), str_contents.end());
            strDescription.Format("%s%s", OTString::trim(str_contents).c_str(),
                                  bTruncated ? "..." : "");
        }
    }
    str_output = strDescription.Get();
    return (!str_output.empty());
}

const std::string & opentxs::OTRecord::GetAccountID

(

)

const

Definition at line 1221 of file OTRecord.cpp.

{
    return m_str_account_id;
}

const std::string & opentxs::OTRecord::GetAddress

(

)

const

Definition at line 1265 of file OTRecord.cpp.

{
    return m_str_my_address;
}

const std::string & opentxs::OTRecord::GetAmount

(

)

const

Definition at line 1241 of file OTRecord.cpp.

{
    return m_str_amount;
}

const std::string & opentxs::OTRecord::GetAssetID

(

)

const

Definition at line 1209 of file OTRecord.cpp.

{
    return m_str_asset_id;
}

int32_t opentxs::OTRecord::GetBoxIndex

(

)

const

Definition at line 1313 of file OTRecord.cpp.

{
    return m_nBoxIndex;
}

const std::string & opentxs::OTRecord::GetContents

(

)

const

Definition at line 1253 of file OTRecord.cpp.

{
    return m_str_contents;
}

const std::string & opentxs::OTRecord::GetCurrencyTLA

(

)

const

Definition at line 1213 of file OTRecord.cpp.

{
    return m_str_currency_tla;
}

const std::string & opentxs::OTRecord::GetDate

(

)

const

Definition at line 1237 of file OTRecord.cpp.

{
    return m_str_date;
}

int64_t opentxs::OTRecord::GetInitialPaymentAmount

(

)

const

Definition at line 467 of file OTRecord.cpp.

{
    if (!IsPaymentPlan()) return 0;

    OTPaymentPlan thePlan;
    const OTString strPlan(GetContents().c_str());

    if (thePlan.LoadContractFromString(strPlan) && thePlan.HasInitialPayment())
        return thePlan.GetInitialPaymentAmount();
    return 0;
}

time64_t opentxs::OTRecord::GetInitialPaymentDate

(

)

const

Definition at line 455 of file OTRecord.cpp.

{
    if (!IsPaymentPlan()) return OT_TIME_ZERO;

    OTPaymentPlan thePlan;
    const OTString strPlan(GetContents().c_str());

    if (thePlan.LoadContractFromString(strPlan) && thePlan.HasInitialPayment())
        return thePlan.GetInitialPaymentDate();
    return OT_TIME_ZERO;
}

const std::string & opentxs::OTRecord::GetInstrumentType

(

)

const

Definition at line 1245 of file OTRecord.cpp.

{
    return m_str_type;
}

int32_t opentxs::OTRecord::GetMaximumNoPayments

(

)

const

Definition at line 515 of file OTRecord.cpp.

{
    if (!IsPaymentPlan()) return 0;

    OTPaymentPlan thePlan;
    const OTString strPlan(GetContents().c_str());

    if (thePlan.LoadContractFromString(strPlan) && thePlan.HasPaymentPlan())
        return thePlan.GetMaximumNoPayments();
    return 0;
}

const std::string & opentxs::OTRecord::GetMemo

(

)

const

Definition at line 1249 of file OTRecord.cpp.

{
    return m_str_memo;
}

int32_t opentxs::OTRecord::GetMethodID

(

)

const

Definition at line 1261 of file OTRecord.cpp.

{
    return m_nMethodID;
}

const std::string & opentxs::OTRecord::GetMsgID

(

)

const

Definition at line 1273 of file OTRecord.cpp.

{
    return m_str_msg_id;
}

const std::string & opentxs::OTRecord::GetMsgType

(

)

const

Definition at line 1277 of file OTRecord.cpp.

{
    return m_str_msg_type;
}

const std::string & opentxs::OTRecord::GetMsgTypeDisplay

(

)

const

Definition at line 1281 of file OTRecord.cpp.

{
    return m_str_msg_type_display;
}

const std::string & opentxs::OTRecord::GetName

(

)

const

Definition at line 1233 of file OTRecord.cpp.

{
    return m_str_name;
}

const std::string & opentxs::OTRecord::GetNymID

(

)

const

Definition at line 1217 of file OTRecord.cpp.

{
    return m_str_nym_id;
}

const std::string & opentxs::OTRecord::GetOtherAccountID

(

)

const

Definition at line 1229 of file OTRecord.cpp.

{
    return m_str_other_account_id;
}

const std::string & opentxs::OTRecord::GetOtherAddress

(

)

const

Definition at line 1269 of file OTRecord.cpp.

{
    return m_str_other_address;
}

const std::string & opentxs::OTRecord::GetOtherNymID

(

)

const

Definition at line 1225 of file OTRecord.cpp.

{
    return m_str_other_nym_id;
}

int64_t opentxs::OTRecord::GetPaymentPlanAmount

(

)

const

Definition at line 503 of file OTRecord.cpp.

{
    if (!IsPaymentPlan()) return 0;

    OTPaymentPlan thePlan;
    const OTString strPlan(GetContents().c_str());

    if (thePlan.LoadContractFromString(strPlan) && thePlan.HasPaymentPlan())
        return thePlan.GetPaymentPlanAmount();
    return 0;
}

time64_t opentxs::OTRecord::GetPaymentPlanStartDate

(

)

const

Definition at line 479 of file OTRecord.cpp.

{
    if (!IsPaymentPlan()) return OT_TIME_ZERO;

    OTPaymentPlan thePlan;
    const OTString strPlan(GetContents().c_str());

    if (thePlan.LoadContractFromString(strPlan) && thePlan.HasPaymentPlan())
        return thePlan.GetPaymentPlanStartDate();
    return OT_TIME_ZERO;
}

OTRecord::OTRecordType opentxs::OTRecord::GetRecordType

(

)

const

Definition at line 526 of file OTRecord.cpp.

{
    return m_RecordType;
}

const std::string & opentxs::OTRecord::GetServerID

(

)

const

Definition at line 1205 of file OTRecord.cpp.

{
    return m_str_server_id;
}

time64_t opentxs::OTRecord::GetTimeBetweenPayments

(

)

const

Definition at line 491 of file OTRecord.cpp.

{
    if (!IsPaymentPlan()) return OT_TIME_ZERO;

    OTPaymentPlan thePlan;
    const OTString strPlan(GetContents().c_str());

    if (thePlan.LoadContractFromString(strPlan) && thePlan.HasPaymentPlan())
        return thePlan.GetTimeBetweenPayments();
    return OT_TIME_ZERO;
}

int64_t opentxs::OTRecord::GetTransactionNum

(

)

const

Definition at line 1142 of file OTRecord.cpp.

{
    return m_lTransactionNum;
} // Trans Num of receipt in the box. (Unless outpayment, contains number for

int64_t opentxs::OTRecord::GetTransNumForDisplay

(

)

const

Definition at line 1151 of file OTRecord.cpp.

{
    if (m_lTransNumForDisplay > 0) return m_lTransNumForDisplay;

    return m_lTransactionNum;
}

time64_t opentxs::OTRecord::GetValidFrom

(

)

const

Definition at line 1368 of file OTRecord.cpp.

{
    return m_ValidFrom;
}

time64_t opentxs::OTRecord::GetValidTo

(

)

const

Definition at line 1372 of file OTRecord.cpp.

{
    return m_ValidTo;
}

bool opentxs::OTRecord::HasContents

(

)

const

Definition at line 1189 of file OTRecord.cpp.

{
    return !m_str_contents.empty();
}

bool opentxs::OTRecord::HasInitialPayment

(

)

const

Definition at line 431 of file OTRecord.cpp.

{
    if (!IsPaymentPlan()) return false;

    OTPaymentPlan thePlan;
    const OTString strPlan(GetContents().c_str());

    if (thePlan.LoadContractFromString(strPlan) && thePlan.HasInitialPayment())
        return true;
    return false;
}

bool opentxs::OTRecord::HasMemo

(

)

const

Definition at line 1193 of file OTRecord.cpp.

{
    return !m_str_memo.empty();
}

bool opentxs::OTRecord::HasPaymentPlan

(

)

const

Definition at line 443 of file OTRecord.cpp.

{
    if (!IsPaymentPlan()) return false;

    OTPaymentPlan thePlan;
    const OTString strPlan(GetContents().c_str());

    if (thePlan.LoadContractFromString(strPlan) && thePlan.HasPaymentPlan())
        return true;
    return false;
}

bool opentxs::OTRecord::IsCanceled

(

)

const

Definition at line 1201 of file OTRecord.cpp.

{
    return m_bIsCanceled;
}

bool opentxs::OTRecord::IsCash

(

)

const

Definition at line 990 of file OTRecord.cpp.

{
    return m_bIsCash;
}

bool opentxs::OTRecord::IsCheque

(

)

const

Definition at line 998 of file OTRecord.cpp.

{
    return m_bIsCheque;
}

bool opentxs::OTRecord::IsContract

(

)

const

Definition at line 1006 of file OTRecord.cpp.

{
    return m_bIsSmartContract;
}

bool opentxs::OTRecord::IsExpired

(

)

const

Definition at line 1197 of file OTRecord.cpp.

{
    return m_bIsExpired;
}

bool opentxs::OTRecord::IsInvoice

(

)

const

Definition at line 994 of file OTRecord.cpp.

{
    return m_bIsInvoice;
}

bool opentxs::OTRecord::IsMail

(

)

const

Definition at line 1169 of file OTRecord.cpp.

{
    return OTRecord::Mail == GetRecordType();
}

bool opentxs::OTRecord::IsOutgoing

(

)

const

Definition at line 1177 of file OTRecord.cpp.

{
    return m_bIsOutgoing;
}

bool opentxs::OTRecord::IsPaymentPlan

(

)

const

Definition at line 1010 of file OTRecord.cpp.

{
    return m_bIsPaymentPlan;
}

bool opentxs::OTRecord::IsPending

(

)

const

Definition at line 1173 of file OTRecord.cpp.

{
    return m_bIsPending;
}

bool opentxs::OTRecord::IsReceipt

(

)

const

Definition at line 1185 of file OTRecord.cpp.

{
    return m_bIsReceipt;
}

bool opentxs::OTRecord::IsRecord

(

)

const

Definition at line 1181 of file OTRecord.cpp.

{
    return m_bIsRecord;
}

bool opentxs::OTRecord::IsSpecialMail

(

)

const

Definition at line 1257 of file OTRecord.cpp.

{
    return m_bIsSpecialMail;
}

bool opentxs::OTRecord::IsTransfer

(

)

const

Definition at line 986 of file OTRecord.cpp.

{
    return (OTRecord::Transfer == m_RecordType);
}

bool opentxs::OTRecord::IsVoucher

(

)

const

Definition at line 1002 of file OTRecord.cpp.

{
    return m_bIsVoucher;
}

bool opentxs::OTRecord::operator<

(

const OTRecord &

rhs

)

Definition at line 1385 of file OTRecord.cpp.

{
    return m_ValidFrom < rhs.m_ValidFrom;
}

void opentxs::OTRecord::SetAddress

(

const std::string &

str_Address

)

Definition at line 1293 of file OTRecord.cpp.

{
    m_str_my_address = str_Address;
}

void opentxs::OTRecord::SetBoxIndex

(

int32_t

nBoxIndex

)

Definition at line 1317 of file OTRecord.cpp.

{
    m_nBoxIndex = nBoxIndex;
}

void opentxs::OTRecord::SetCanceled

(

)

Definition at line 1165 of file OTRecord.cpp.

{
    m_bIsCanceled = true;
}

void opentxs::OTRecord::SetContents

(

const std::string &

str_contents

)

Definition at line 1333 of file OTRecord.cpp.

{
    m_str_contents = str_contents;

    if (!m_str_contents.empty() && (OTRecord::Instrument == GetRecordType())) {
        OTString strPayment(m_str_contents);
        OTPayment thePayment(strPayment);

        if (thePayment.IsValid() && thePayment.SetTempValues()) {
            switch (thePayment.GetType()) {
            case OTPayment::PURSE:
                m_bIsCash = true;
                break;
            case OTPayment::CHEQUE:
                m_bIsCheque = true;
                break;
            case OTPayment::VOUCHER:
                m_bIsVoucher = true;
                break;
            case OTPayment::INVOICE:
                m_bIsInvoice = true;
                break;
            case OTPayment::PAYMENT_PLAN:
                m_bIsPaymentPlan = true;
                break;
            case OTPayment::SMART_CONTRACT:
                m_bIsSmartContract = true;
                break;

            default:
                break;
            }
        }
    }
}

void opentxs::OTRecord::SetDateRange	(	time64_t	tValidFrom,
		time64_t	tValidTo
	)

Definition at line 1376 of file OTRecord.cpp.

{
    m_ValidFrom = tValidFrom;
    m_ValidTo = tValidTo;
    time64_t tCurrentTime = OTAPI_Wrap::GetTime();
    if ((tValidTo > OT_TIME_ZERO) && (tCurrentTime > tValidTo) && !IsMail() &&
        !IsRecord())
        SetExpired();
}

void opentxs::OTRecord::SetExpired

(

)

Definition at line 1161 of file OTRecord.cpp.

{
    m_bIsExpired = true;
}

void opentxs::OTRecord::SetMemo

(

const std::string &

str_memo

)

Definition at line 1321 of file OTRecord.cpp.

{
    m_str_memo = str_memo;
}

void opentxs::OTRecord::SetMethodID

(

int32_t

nMethodID

)

Definition at line 1289 of file OTRecord.cpp.

{
    m_nMethodID = nMethodID;
}

void opentxs::OTRecord::SetMsgID

(

const std::string &

str_id

)

Definition at line 1301 of file OTRecord.cpp.

{
    m_str_msg_id = str_id;
}

void opentxs::OTRecord::SetMsgType

(

const std::string &

str_type

)

Definition at line 1305 of file OTRecord.cpp.

{
    m_str_msg_type = str_type;
}

void opentxs::OTRecord::SetMsgTypeDisplay

(

const std::string &

str_type

)

Definition at line 1309 of file OTRecord.cpp.

{
    m_str_msg_type_display = str_type;
}

void opentxs::OTRecord::SetOtherAccountID

(

const std::string &

str_ID

)

Definition at line 1329 of file OTRecord.cpp.

{
    m_str_other_account_id = str_ID;
}

void opentxs::OTRecord::SetOtherAddress

(

const std::string &

str_Address

)

Definition at line 1297 of file OTRecord.cpp.

{
    m_str_other_address = str_Address;
}

void opentxs::OTRecord::SetOtherNymID

(

const std::string &

str_ID

)

Definition at line 1325 of file OTRecord.cpp.

{
    m_str_other_nym_id = str_ID;
}

void opentxs::OTRecord::SetSpecialMail

(

bool

bIsSpecial = true

)

Definition at line 1285 of file OTRecord.cpp.

{
    m_bIsSpecialMail = bIsSpecial;
}

void opentxs::OTRecord::SetTransactionNum

(

int64_t

lTransNum

)

Definition at line 1147 of file OTRecord.cpp.

{
    m_lTransactionNum = lTransNum;
}

void opentxs::OTRecord::SetTransNumForDisplay

(

int64_t

lTransNum

)

Definition at line 1157 of file OTRecord.cpp.

{
    m_lTransNumForDisplay = lTransNum;
}

---

The documentation for this class was generated from the following files:

• /usr/local/src/opentxs/include/opentxs/client/OTRecord.hpp
• /usr/local/src/opentxs/src/client/OTRecord.cpp