ofx4js/lib/domain/data/common/BalanceRecord.d.ts

A javascript OFX library, ported from OFX4J

import { Currency } from "./Currency";
export declare enum BalanceRecordType {
    DOLLAR = 0,
    PERCENT = 1,
    NUMBER = 2
}
/**
 * @see "Section 3.1.3, OFX Spec"
 */
export declare class BalanceRecord {
    private name;
    private description;
    private type;
    private value;
    private timestamp;
    private currency;
    /**
     * Name of the balance.
     *
     * @return Name of the balance.
     */
    getName(): string;
    /**
     * Name of the balance.
     *
     * @param name Name of the balance.
     */
    setName(name: string): void;
    /**
     * Description of the balance.
     *
     * @return Description of the balance.
     */
    getDescription(): string;
    /**
     * Description of the balance.
     *
     * @param description Description of the balance.
     */
    setDescription(description: string): void;
    /**
     * Type of the balance.
     *
     * @return Type of the balance.
     */
    getType(): BalanceRecordType;
    /**
     * Type of the balance.
     *
     * @param type Type of the balance.
     */
    setType(type: BalanceRecordType): void;
    /**
     * The value of the balance.
     *
     * @return The value of the balance.
     */
    getValue(): string;
    /**
     * The value of the balance.
     *
     * @param value The value of the balance.
     */
    setValue(value: string): void;
    /**
     * Timestamp of the balance.
     *
     * @return Timestamp of the balance.
     */
    getTimestamp(): Date;
    /**
     * Timestamp of the balance.
     *
     * @param timestamp Timestamp of the balance.
     */
    setTimestamp(timestamp: Date): void;
    /**
     * Currency.
     *
     * @return Currency.
     */
    getCurrency(): Currency;
    /**
     * Currency.
     *
     * @param currency Currency.
     */
    setCurrency(currency: Currency): void;
}