ofx4js/lib/domain/data/seclist/MutualFundSecurityInfo.d.ts

A javascript OFX library, ported from OFX4J

import { BaseSecurityInfo } from "./BaseSecurityInfo";
import { MutualFundType } from "./MutualFundType";
/**
 * Info about a mutual fund security.
 * @see "Section 13.8.5.3, OFX Spec"
 */
export declare class MutualFundSecurityInfo extends BaseSecurityInfo {
    private mfType;
    private yield;
    private dateYieldAsOf;
    /**
     * Gets the mutual fund type. One of "OPENEND", "CLOSEEND", or "OTHER". This is an optional field
     * according to the OFX spec.
     *
     * @return the mutual fund type
     */
    getType(): string;
    /**
     * Sets the mutual fund type. One of "OPENEND", "CLOSEEND", or "OTHER". This is an optional field
     * according to the OFX spec.
     *
     * @param mfType the mutual fund type
     */
    setType(mfType: string): void;
    /**
     * Gets the mutual fund type as one of the well-known types.
     *
     * @return the mutual fund type or null if it's not one of the well-known types
     */
    getTypeEnum(): MutualFundType;
    /**
     * Gets the yield as a rate. This is an optional field according to the OFX spec.
     *
     * @return the yield as a rate
     */
    getYield(): number;
    /**
     * Sets the yield as a rate. This is an optional field according to the OFX spec.
     *
     * @param yield the yield as a rate
     */
    setYield(yield_: number): void;
    /**
     * Gets the as-of date for the yield. This is an optional field according to the OFX spec.
     *
     * @return the as-of date for the yield
     */
    getDateYieldAsOf(): Date;
    /**
     * Sets the as-of date for the yield. This is an optional field according to the OFX spec.
     *
     * @param dateYieldAsOf the as-of date for the yield
     */
    setDateYieldAsOf(dateYieldAsOf: Date): void;
}