ofx4js/lib/domain/data/ResponseEnvelope.d.ts

A javascript OFX library, ported from OFX4J

import { ApplicationSecurity } from "./ApplicationSecurity";
import { SortedSet } from "../../collections/SortedSet";
import { ResponseMessageSet } from "./ResponseMessageSet";
import { SignonResponse } from "./signon/SignonResponse";
import { MessageSetType } from "./MessageSetType";
/**
 * Envelope for enclosing an OFX response.
 *
 * @see "Section 2.4.3, OFX Spec"
 */
export declare class ResponseEnvelope {
    private security;
    private UID;
    private messageSets;
    /**
     * The security of this envelope.
     *
     * @return The security of this envelope.
     * @see "Section 2.2, OFX spec"
     */
    getSecurity(): ApplicationSecurity;
    /**
     * The security of this envelope.
     *
     * @param security The security of this envelope.
     * @see "Section 2.2, OFX spec"
     */
    setSecurity(security: ApplicationSecurity): void;
    /**
     * The UID for the envelope.
     *
     * @return The UID for the envelope.
     * @see "Section 2.2, OFX spec"
     */
    getUID(): string;
    /**
     * The UID for the envelope.
     *
     * @param UID The UID for the envelope.
     * @see "Section 2.2, OFX spec"
     */
    setUID(UID: string): void;
    /**
     * The message sets that make up the content of this response.
     *
     * @return The message sets that make up the content of this response.
     * @see "Section 2.4.5, OFX Spec"
     */
    getMessageSets(): SortedSet<ResponseMessageSet>;
    /**
     * The message sets that make up the content of this response.
     *
     * @param messageSets The message sets that make up the content of this response.
     * @see "Section 2.4.5, OFX Spec"
     */
    setMessageSets(messageSets: SortedSet<ResponseMessageSet>): void;
    /**
     * Helper method for looking up the signon response.
     *
     * @return The signon response, or null if none found.
     */
    getSignonResponse(): SignonResponse;
    /**
     * Get the message set of the specified type.
     *
     * @param type The type.
     * @return The message set, or null.
     */
    getMessageSet(type: MessageSetType): ResponseMessageSet;
}