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

A javascript OFX library, ported from OFX4J

import { SortedSet } from '../../collections/SortedSet';
import { ApplicationSecurity } from './ApplicationSecurity';
import { RequestMessageSet } from './RequestMessageSet';
/**
 * Envelope for enclosing an OFX request.
 *
 * @see "Section 2.4.3, OFX Spec"
 */
export declare class RequestEnvelope {
    private security;
    private UID;
    private lastProcessedUID;
    private messageSets;
    constructor(UID?: string);
    /**
     * 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 UID of the last-processed request/response (used for file-based error recovery).
     *
     * @return The UID of the last-processed request/response (used for file-based error recovery).
     * @see "Section 2.2, OFX spec"
     */
    getLastProcessedUID(): string;
    /**
     * The UID of the last-processed request/response (used for file-based error recovery).
     *
     * @param lastProcessedUID The UID of the last-processed request/response (used for file-based error recovery).
     * @see "Section 2.2, OFX spec"
     */
    setLastProcessedUID(lastProcessedUID: string): void;
    /**
     * The message sets that make up the content of this request.
     *
     * @return The message sets that make up the content of this request.
     * @see "Section 2.4.5, OFX Spec"
     */
    getMessageSets(): SortedSet<RequestMessageSet>;
    /**
     * The message sets that make up the content of this request.
     *
     * @param messageSets The message sets that make up the content of this request.
     * @see "Section 2.4.5, OFX Spec"
     */
    setMessageSets(messageSets: SortedSet<RequestMessageSet>): void;
}