@beinformed/ui 1.30.0 → 1.31.0

package/types/models/form/FormModel.d.ts

@@ -1,320 +1,343 @@
-export default FormModel;
-/**
- */
-declare class FormModel extends ResourceModel {
-    _lastUpdate: number;
-    _completedFormObjects: Array<FormObjectModel>;
-    _currentFormObject: FormObjectModel | null;
-    _previouslyEnteredFormObjects: Array<FormObjectModel>;
-    _mergePreviouslyEnteredObjects: boolean;
-    _endResultFormObjects: Array<FormObjectModel>;
-    _previousEndResultKeys: Array<string>;
-    _useClientsideValidation: boolean;
-    _errorCollection: ErrorCollection;
-    _redirectLocation: Href;
-    _commit: boolean;
-    _isFinished: boolean;
-    _isComplete: boolean;
-    _parameters: Array<Parameter>;
-    _tokens: Array<string>;
-    /**
-     */
-    set lastUpdate(arg: number);
-    /**
-     */
-    get lastUpdate(): number;
-    /**
-     */
-    set currentFormObject(arg: FormObjectModel);
-    /**
-     */
-    get currentFormObject(): FormObjectModel;
-    /**
-     */
-    set endResultFormObjects(arg: FormObjectModel[]);
-    /**
-     */
-    get endResultFormObjects(): FormObjectModel[];
-    /**
-     */
-    set parameters(arg: Parameter[]);
-    /**
-     */
-    get parameters(): Parameter[];
-    /**
-     */
-    set isComplete(arg: boolean);
-    /**
-     * Indicates if form is completely entered
-     */
-    get isComplete(): boolean;
-    /**
-     */
-    get actiontype(): string;
-    /**
-     * Get form level button labels
-     */
-    get buttonLabels(): Object;
-    /**
-     * @returns button label from contributions;
-     */
-    getButtonLabel(buttonType: "cancel" | "previous" | "next" | "finish"): string | null;
-    /**
-     * Get all applicable objects
-     */
-    get allObjects(): FormObjectModel[];
-    /**
-     */
-    get objectKeys(): string[];
-    /**
-     */
-    get numberOfExpectedQuestions(): number;
-    /**
-     * Has questions configured on form
-     */
-    get hasNoQuestionsConfigured(): boolean;
-    /**
-     */
-    addGlobalDynamicSchema(anchor: Object, dynamicschema: Object): Object;
-    /**
-     */
-    getMissingAnchors(): Array<Object>;
-    /**
-     * Create form object based on the data and contributions available in this form
-     */
-    createFormObject(): FormObjectModel | null;
-    /**
-     */
-    addEmptyFormObject(formObjectModel?: FormObjectModel | null): void;
-    /**
-     */
-    getHighestRepeatIndex(formObjectModel: FormObjectModel): number;
-    /**
-     */
-    addFormObject(formObjectModel: FormObjectModel): void;
-    /**
-     */
-    set completedFormObjects(arg: FormObjectModel[]);
-    /**
-     * Completed objects are previously entered questions
-     */
-    get completedFormObjects(): FormObjectModel[];
-    /**
-     * Retrieve a form object by the key
-     */
-    getFormObjectByKey(key: string): FormObjectModel | null;
-    /**
-     * Retrieve a form object by a layouthint
-     */
-    getFormObjectByLayoutHint(hint: string): FormObjectModel | null;
-    /**
-     */
-    removeFormObject(formObjectModel: FormObjectModel | null): void;
-    /**
-     */
-    set previouslyEnteredFormObjects(arg: FormObjectModel[]);
-    /**
-     * Previously entered objects are questions that have been entered before,
-     * but are currently not applicable for the form.
-     * For example because of previous navigation
-     */
-    get previouslyEnteredFormObjects(): FormObjectModel[];
-    /**
-     * Handle end results
-     */
-    setEndResultFormObjects(): Array<FormObjectModel>;
-    /**
-     */
-    get expectsEndResultFormObjects(): boolean;
-    /**
-     */
-    getEndResultFormObjects(): Array<FormObjectModel>;
-    /**
-     */
-    set previousEndResultKeys(arg: string[]);
-    /**
-     */
-    get previousEndResultKeys(): string[];
-    /**
-     * Error handling
-     */
-    get isValid(): boolean;
-    /**
-     */
-    hasServerErrors(): boolean;
-    /**
-     */
-    hasErrors(): boolean;
-    /**
-     * Add an error to the error collection of this form
-     */
-    addServerError(error: ErrorResponse): void;
-    /**
-     * Reset error messages
-     */
-    resetErrors(): void;
-    /**
-     */
-    set errorCollection(arg: ErrorCollection);
-    /**
-     */
-    get errorCollection(): ErrorCollection;
-    /**
-     */
-    set commit(arg: boolean);
-    /**
-     * Indicates if the form needs to be committed
-     */
-    get commit(): boolean;
-    /**
-     */
-    set isFinished(arg: boolean);
-    /**
-     * Inidicates if form is finished: Form is completely entered and committed
-     */
-    get isFinished(): boolean;
-    /**
-     * Handle success redirects
-     */
-    get successRedirect(): Href;
-    /**
-     */
-    get redirectLocation(): Href;
-    /**
-     * Get the result data as plain json object
-     */
-    getSuccessData(): Object | null;
-    /**
-     * Retrieve an object where each property is a result data attribute set
-     */
-    getResultData(): {
-        [key: string]: AttributeSetModel;
-    };
-    /**
-     */
-    get resultData(): Object;
-    /**
-     * Href handling
-     */
-    setParameters(modularuiResponse: ModularUIResponse): Array<Parameter>;
-    /**
-     */
-    selfhrefNoCommitParam(): Href;
-    /**
-     */
-    selfhrefWithCommitParam(): Href;
-    /**
-     * Replaces all tokens with the given collection of tokens
-     */
-    set tokens(arg: string[]);
-    /**
-     * Handle form tokens to indicate concurrent form use
-     */
-    get tokens(): string[];
-    /**
-     * Removes all tokens from the form
-     */
-    removeTokens(): void;
-    /**
-     * Keep track of changed form
-     */
-    isChanged(): boolean;
-    /**
-     */
-    getFormDataObjects(validOnly?: boolean, validationData?: boolean): Array<Object>;
-    /**
-     */
-    getFormData(validOnly?: boolean, withConcurrencyToken?: boolean, validationData?: boolean): string;
-    /**
-     * Used to programmatically overwrite the setting USE_CLIENTSIDE_VALIDATION
-     */
-    setUseClientsideValidation(enabled: boolean): void;
-    /**
-     * Indicates if client side validation is enabled
-     * @returns {boolean}
-     */
-    useClientsideValidation(): boolean;
-    /**
-     * Get form data for submitting
-     */
-    get formdata(): string;
-    /**
-     */
-    get validationData(): string;
-    /**
-     * Form navigation: Go one object back (previous button)
-     */
-    get hasPreviousStep(): boolean;
-    /**
-     * Go one form-object back,
-     * for repeating object this means go back
-     * until we get at a form object that had
-     * a different key than the current form object
-     */
-    setPreviousObject(): void;
-    /**
-     * Form navigation: has next step or is last
-     */
-    get hasNextStep(): boolean;
-    /**
-     * Merge existing form with new form
-     */
-    update(receivedForm: ModularUIModel): FormModel;
-    lastServerUpdate: any;
-    /**
-     */
-    updateValidations(data: any): FormModel;
-    /**
-     * Process finished form
-     */
-    handleFinished(receivedForm: FormModel): void;
-    _data: any;
-    /**
-     */
-    handleRootErrors(errors: Array<Object>): void;
-    /**
-     * Process errors from received form
-     */
-    handleErrors(receivedForm: FormModel): void;
-    /**
-     * Process missing from received form
-     */
-    handleMissing(receivedForm: FormModel): void;
-    /**
-     * Received missing anchors in the response with an object id that is the current form object
-     */
-    processMissingErrors(receivedForm: FormModel): FormObjectModel | null;
-    /**
-     */
-    handleMissingErrors(receivedForm: FormModel): void;
-    /**
-     */
-    handleNewFormObject(receivedForm: FormModel): void;
-    /**
-     */
-    set mergePreviouslyEnteredObjects(arg: boolean);
-    /**
-     * Indicate if a new form object model should be merged with a previousled entered form object model
-     * Set this property to false on the form that receives the new form to skip the merge behavior
-     */
-    get mergePreviouslyEnteredObjects(): boolean;
-    /**
-     */
-    handlePreviouslyEnteredFormObjects(receivedCurrentFormObject: FormObjectModel, previouslyEnteredFormObjects: Array<FormObjectModel>): void;
-    /**
-     */
-    mergeObjects(newObject: FormObjectModel, oldObject: FormObjectModel): FormObjectModel;
-    /**
-     */
-    findAttribute(findMethod: Function): AttributeType | null;
-}
-import ResourceModel from "../base/ResourceModel";
-import FormObjectModel from "./FormObjectModel";
-import ErrorCollection from "../error/ErrorCollection";
-import Href from "../href/Href";
-import Parameter from "../parameter/Parameter";
-import ErrorResponse from "../error/ErrorResponse";
-import AttributeSetModel from "../attributes/AttributeSetModel";
-import { ModularUIResponse } from "../../modularui";
-import { ModularUIModel } from "../types";
-import { AttributeType } from "../types";
+export default FormModel;
+/**
+ */
+declare class FormModel extends ResourceModel {
+    _lastUpdate: number;
+    _completedFormObjects: Array<FormObjectModel>;
+    _currentFormObject: FormObjectModel | null;
+    _previouslyEnteredFormObjects: Array<FormObjectModel>;
+    _mergePreviouslyEnteredObjects: boolean;
+    _endResultFormObjects: Array<FormObjectModel>;
+    _previousEndResultKeys: Array<string>;
+    _useClientsideValidation: boolean;
+    _errorCollection: ErrorCollection;
+    _redirectLocation: Href;
+    _commit: boolean;
+    _isFinished: boolean;
+    _isComplete: boolean;
+    _success: {
+        redirect: string;
+        data: Object;
+    } | null;
+    _parameters: Array<Parameter>;
+    _tokens: Array<string>;
+    /**
+     */
+    set lastUpdate(arg: number);
+    /**
+     */
+    get lastUpdate(): number;
+    /**
+     */
+    set currentFormObject(arg: FormObjectModel);
+    /**
+     */
+    get currentFormObject(): FormObjectModel;
+    /**
+     */
+    set endResultFormObjects(arg: FormObjectModel[]);
+    /**
+     */
+    get endResultFormObjects(): FormObjectModel[];
+    /**
+     */
+    set parameters(arg: Parameter[]);
+    /**
+     */
+    get parameters(): Parameter[];
+    /**
+     */
+    set isComplete(arg: boolean);
+    /**
+     * Indicates if form is completely entered
+     */
+    get isComplete(): boolean;
+    /**
+     */
+    get actiontype(): string;
+    /**
+     * Get form level button labels
+     */
+    get buttonLabels(): Object;
+    /**
+     * @returns button label from contributions;
+     */
+    getButtonLabel(buttonType: "cancel" | "previous" | "next" | "finish"): string | null;
+    /**
+     * Get all applicable objects
+     */
+    get allObjects(): FormObjectModel[];
+    /**
+     */
+    get objectKeys(): string[];
+    /**
+     */
+    get numberOfExpectedQuestions(): number;
+    /**
+     * Has questions configured on form
+     */
+    get hasNoQuestionsConfigured(): boolean;
+    /**
+     */
+    addGlobalDynamicSchema(anchor: Object, dynamicschema: Object): Object;
+    /**
+     */
+    getMissingAnchors(): Array<Object>;
+    /**
+     * Create form object based on the data and contributions available in this form
+     */
+    createFormObject(): FormObjectModel | null;
+    /**
+     */
+    addEmptyFormObject(formObjectModel?: FormObjectModel | null): void;
+    /**
+     */
+    getHighestRepeatIndex(formObjectModel: FormObjectModel): number;
+    /**
+     */
+    addFormObject(formObjectModel: FormObjectModel): void;
+    /**
+     */
+    set completedFormObjects(arg: FormObjectModel[]);
+    /**
+     * Completed objects are previously entered questions
+     */
+    get completedFormObjects(): FormObjectModel[];
+    /**
+     * Retrieve a form object by the key
+     */
+    getFormObjectByKey(key: string): FormObjectModel | null;
+    /**
+     * Retrieve a form object by a layouthint
+     */
+    getFormObjectByLayoutHint(hint: string): FormObjectModel | null;
+    /**
+     */
+    removeFormObject(formObjectModel: FormObjectModel | null): void;
+    /**
+     */
+    set previouslyEnteredFormObjects(arg: FormObjectModel[]);
+    /**
+     * Previously entered objects are questions that have been entered before,
+     * but are currently not applicable for the form.
+     * For example because of previous navigation
+     */
+    get previouslyEnteredFormObjects(): FormObjectModel[];
+    /**
+     * Handle end results
+     */
+    setEndResultFormObjects(): Array<FormObjectModel>;
+    /**
+     */
+    get expectsEndResultFormObjects(): boolean;
+    /**
+     */
+    getEndResultFormObjects(): Array<FormObjectModel>;
+    /**
+     */
+    set previousEndResultKeys(arg: string[]);
+    /**
+     */
+    get previousEndResultKeys(): string[];
+    /**
+     * Error handling
+     */
+    get isValid(): boolean;
+    /**
+     */
+    hasServerErrors(): boolean;
+    /**
+     */
+    hasErrors(): boolean;
+    /**
+     * Add an error to the error collection of this form
+     */
+    addServerError(error: ErrorResponse): void;
+    /**
+     * Reset error messages
+     */
+    resetErrors(): void;
+    /**
+     */
+    set errorCollection(arg: ErrorCollection);
+    /**
+     */
+    get errorCollection(): ErrorCollection;
+    /**
+     */
+    set commit(arg: boolean);
+    /**
+     * Indicates if the form needs to be committed
+     */
+    get commit(): boolean;
+    /**
+     */
+    set isFinished(arg: boolean);
+    /**
+     * Inidicates if form is finished: Form is completely entered and committed
+     */
+    get isFinished(): boolean;
+    /**
+     * Handle success redirects
+     */
+    get successRedirect(): Href;
+    /**
+     */
+    get redirectLocation(): Href;
+    /**
+     * Get the result data as plain json object
+     */
+    getSuccessData(): Object | null;
+    /**
+     * Retrieve an object where each property is a result data attribute set
+     */
+    getResultData(): {
+        [key: string]: AttributeSetModel;
+    };
+    /**
+     */
+    get resultData(): Object;
+    /**
+     * Href handling
+     */
+    setParameters(modularuiResponse: ModularUIResponse): Array<Parameter>;
+    /**
+     */
+    selfhrefNoCommitParam(): Href;
+    /**
+     */
+    selfhrefWithCommitParam(): Href;
+    /**
+     * Replaces all tokens with the given collection of tokens
+     */
+    set tokens(arg: string[]);
+    /**
+     * Handle form tokens to indicate concurrent form use
+     */
+    get tokens(): string[];
+    /**
+     * Removes all tokens from the form
+     */
+    removeTokens(): void;
+    /**
+     * Keep track of changed form
+     */
+    isChanged(): boolean;
+    /**
+     */
+    getFormDataObjects(validOnly?: boolean, validationData?: boolean): Array<Object>;
+    /**
+     */
+    getFormData(validOnly?: boolean, withConcurrencyToken?: boolean, validationData?: boolean): string;
+    /**
+     * Used to programmatically overwrite the setting USE_CLIENTSIDE_VALIDATION
+     */
+    setUseClientsideValidation(enabled: boolean): void;
+    /**
+     * Indicates if client side validation is enabled
+     * @returns {boolean}
+     */
+    useClientsideValidation(): boolean;
+    /**
+     * Get form data for submitting
+     */
+    get formdata(): string;
+    /**
+     */
+    get validationData(): string;
+    /**
+     * Form navigation: Go one object back (previous button)
+     */
+    get hasPreviousStep(): boolean;
+    /**
+     * Go one form-object back,
+     * for repeating object this means go back
+     * until we get at a form object that had
+     * a different key than the current form object
+     */
+    setPreviousObject(): void;
+    /**
+     * Set success information, contains redirect and event data
+     * @param success
+     */
+    set success(arg: {
+        redirect: string;
+        data: Object;
+    });
+    /**
+     * Retrieve success information from response
+     * @returns {{redirect: string, data: object}}
+     */
+    get success(): {
+        redirect: string;
+        data: Object;
+    };
+    /**
+     * Form navigation: has next step or is last
+     */
+    get hasNextStep(): boolean;
+    /**
+     * Merge existing form with new form
+     */
+    update(receivedForm: ModularUIModel): FormModel;
+    lastServerUpdate: any;
+    /**
+     */
+    updateValidations(data: any): FormModel;
+    /**
+     */
+    createSuccess(): void;
+    /**
+     * Process finished form
+     */
+    handleFinished(receivedForm: FormModel): void;
+    _data: any;
+    /**
+     */
+    handleRootErrors(errors: Array<Object>): void;
+    /**
+     * Process errors from received form
+     */
+    handleErrors(receivedForm: FormModel): void;
+    /**
+     * Process missing from received form
+     */
+    handleMissing(receivedForm: FormModel): void;
+    /**
+     * Received missing anchors in the response with an object id that is the current form object
+     */
+    processMissingErrors(receivedForm: FormModel): FormObjectModel | null;
+    /**
+     */
+    handleMissingErrors(receivedForm: FormModel): void;
+    /**
+     */
+    handleNewFormObject(receivedForm: FormModel): void;
+    /**
+     */
+    set mergePreviouslyEnteredObjects(arg: boolean);
+    /**
+     * Indicate if a new form object model should be merged with a previousled entered form object model
+     * Set this property to false on the form that receives the new form to skip the merge behavior
+     */
+    get mergePreviouslyEnteredObjects(): boolean;
+    /**
+     */
+    handlePreviouslyEnteredFormObjects(receivedCurrentFormObject: FormObjectModel, previouslyEnteredFormObjects: Array<FormObjectModel>): void;
+    /**
+     */
+    mergeObjects(newObject: FormObjectModel, oldObject: FormObjectModel): FormObjectModel;
+    /**
+     */
+    findAttribute(findMethod: Function): AttributeType | null;
+}
+import ResourceModel from "../base/ResourceModel";
+import FormObjectModel from "./FormObjectModel";
+import ErrorCollection from "../error/ErrorCollection";
+import Href from "../href/Href";
+import Parameter from "../parameter/Parameter";
+import ErrorResponse from "../error/ErrorResponse";
+import AttributeSetModel from "../attributes/AttributeSetModel";
+import { ModularUIResponse } from "../../modularui";
+import { ModularUIModel } from "../types";
+import { AttributeType } from "../types";