@beinformed/ui 1.28.7 → 1.29.0

package/types/models/attributes/AttributeModel.d.ts

@@ -1,395 +1,395 @@
-/**
- * Attribute model, base model for all kind of attributes
- */
-export default class AttributeModel extends BaseModel {
-    /**
-     */
-    static isApplicableModel(contributions: Object): boolean;
-    _label: string;
-    _lastModification: number;
-    _initvalue: any;
-    _inputvalue: string;
-    _value: any;
-    _errorCollection: ErrorCollection;
-    _serverConstraints: ConstraintCollection;
-    _useClientsideValidation: boolean;
-    _isValid: boolean;
-    _validatedValue: string | null;
-    _isEditable: boolean;
-    _concept: ConceptDetailModel | null;
-    _referenceDate: ISO_DATE;
-    _isResult: boolean;
-    _isHidden: boolean;
-    _readonly: boolean;
-    _disabled: boolean;
-    _mandatory: boolean;
-    _links: LinkCollection;
-    _parentKey: string | null;
-    _hasContentConfiguration: boolean;
-    _layoutHintRules: LayoutHintRuleCollection;
-    /**
-     * Retrieve initial input value
-     */
-    getInitialInputValue(value: any): any;
-    /**
-     */
-    getInitialChildModelLinks(): Array<LinkModel>;
-    /**
-     */
-    setChildModels(models: Array<ModularUIModel>): void;
-    /**
-     * Set the concept
-     */
-    set concept(arg: ConceptDetailModel);
-    /**
-     * Get concept information
-     */
-    get concept(): ConceptDetailModel;
-    /**
-     * Getting the attribute key
-     */
-    get key(): string;
-    /**
-     */
-    set parentKey(arg: string);
-    /**
-     */
-    get parentKey(): string;
-    /**
-     * Getting the attribute name
-     */
-    get name(): string;
-    /**
-     * Getting the type of the attribute
-     */
-    get type(): string;
-    /**
-     * Set the label of this attribute
-     */
-    set label(arg: string);
-    /**
-     * Getting the label of the attribute
-     */
-    get label(): string;
-    /**
-     */
-    set hasContentConfiguration(arg: boolean);
-    /**
-     */
-    get hasContentConfiguration(): boolean;
-    /**
-     */
-    indicateContentConfiguration(contentConfiguration: ContentConfiguration): void;
-    /**
-     * Retrieve the first permitted label to render when a concept and contentConfiguration is available
-     * Be aware that permission could be in place for labels from a concept.
-     */
-    getContentConfiguredLabel(contentConfiguration: ContentConfigurationElements | null): string;
-    /**
-     */
-    get defaultAlignment(): "center" | "left" | "right";
-    /**
-     * Handles layout hint align-left, align-center and align-right
-     */
-    get alignment(): "center" | "left" | "right";
-    /**
-     * Retrieve links of attribute
-     */
-    get links(): LinkCollection;
-    /**
-     * Retrieve link of attribute when available
-     */
-    get downloadLink(): LinkModel;
-    /**
-     * Retrieve concept link of attribute when available
-     */
-    get conceptLink(): LinkModel;
-    /**
-     * Set reference date for concepts and content
-     */
-    set referenceDate(arg: ISO_DATE);
-    /**
-     * Retrieve reference date of attribute which can be used as entryDate for content
-     * to get information in correct time version
-     */
-    get referenceDate(): ISO_DATE;
-    /**
-     * Initial value received from the modular ui service
-     */
-    get initvalue(): any;
-    /**
-     * Retrieve input value
-     */
-    getInputValue(): string;
-    /**
-     * Sets the input value to the value entered by the user
-     */
-    set inputvalue(arg: string);
-    /**
-     * Returns the value as entered by the user. This can differ from the internal iso value that is stored
-     */
-    get inputvalue(): string;
-    /**
-     * Value that is used when retrieving an error collection of this attribute
-     * Mostly this is the input value, but sometimes a different value is needed,
-     * for example iban and postcode need to validate length without spaces
-     */
-    get validateValue(): string;
-    /**
-     * Setting a value in the element
-     */
-    set value(arg: any);
-    /**
-     * Getting the value of the attribute
-     */
-    get value(): any;
-    /**
-     */
-    hasValue(): boolean;
-    /**
-     * Getting the value of the attribute
-     */
-    getValue(): any;
-    /**
-     * Getting data ready to be send to the modular ui
-     * Returns null when the attribute should not be send to the server
-     */
-    getFormData(): {
-        [string]: any;
-    } | null;
-    /**
-     */
-    get formdata(): {};
-    /**
-     */
-    getEmptyFormData(): {
-        [string]: null;
-    };
-    /**
-     */
-    formatValue(value: string): string;
-    /**
-     * Getting the readonly value, iso value converted for human reading
-     */
-    get readonlyvalue(): string;
-    /**
-     * Set mandatory status of attribute
-     */
-    set mandatory(arg: boolean);
-    /**
-     * Getting mandatory status of attribute
-     */
-    get mandatory(): boolean;
-    /**
-     */
-    get configuredMandatory(): boolean;
-    /**
-     */
-    set readonly(arg: boolean);
-    /**
-     */
-    get readonly(): boolean;
-    /**
-     */
-    set disabled(arg: boolean);
-    /**
-     */
-    get disabled(): boolean;
-    /**
-     */
-    set isResult(arg: boolean);
-    /**
-     */
-    get isResult(): boolean;
-    /**
-     * Getting the display and input format of a attribute
-     */
-    get format(): string;
-    /**
-     */
-    get formatLabel(): string;
-    /**
-     * Get minimum string length
-     */
-    get minLength(): number;
-    /**
-     * Get maximum string length
-     */
-    get maxLength(): number;
-    /**
-     */
-    get operator(): string;
-    /**
-     * Get assistant message
-     */
-    get assistantMessage(): string;
-    /**
-     * Get valid status
-     */
-    get isValid(): boolean;
-    /**
-     * Retrieve applicable constraint for this attribute
-     */
-    get constraintCollection(): ConstraintCollection;
-    /**
-     * Template method for class extending this model to add extra constraints
-     * @abstract
-     */
-    addConstraints(): ConstraintCollection;
-    /**
-     * Used to programmatically overwrite the setting USE_CLIENTSIDE_VALIDATION
-     */
-    setUseClientsideValidation(enabled: boolean): void;
-    /**
-     * Indicates if client side validation is enabled
-     * @returns {boolean}
-     */
-    useClientsideValidation(): boolean;
-    /**
-     * Validate input on client side constraint
-     */
-    validate(value: string): boolean;
-    /**
-     * Indicates if attribute is optional and empty
-     */
-    isOptionalAndEmpty(value: string): boolean;
-    /**
-     * Retrieve error messages of this attribute
-     */
-    get errorCollection(): ErrorCollection;
-    /**
-     * Check if attribute is in error
-     */
-    inError(): boolean;
-    /**
-     * Reset static error messages on attribute
-     */
-    resetErrors(): void;
-    /**
-     * Registers an error that was received from a server response
-     */
-    addServerError(error: FormErrorAnchor): void;
-    /**
-     */
-    removeServerError(id: string): void;
-    /**
-     */
-    hasServerErrors(): boolean;
-    /**
-     */
-    hasErrors(): boolean;
-    /**
-     * Registers a missing error that was received from the server
-     */
-    addMissingError(): void;
-    /**
-     */
-    removeMissingError(): void;
-    /**
-     */
-    addServerConstraint(id: string, defaultMessage?: string, parameters?: MessageParameters): void;
-    /**
-     */
-    formatParameters(parameters: Object): {
-        [string]: string | number;
-    };
-    /**
-     */
-    get hasDynamicValidationData(): boolean;
-    /**
-     */
-    updateValidations(errors: Array<Object>): void;
-    /**
-     * Set last modification to current timestamp
-     */
-    updateLastModification(): void;
-    /**
-     * Inidicates if attribute is changed since a given timestamp (Date.now)
-     */
-    isChangedSince(timestamp: number): boolean;
-    /**
-     * Abstract reset method which should be implemented on each attribute that has this attribute as a base class.
-     *
-     * @abstract
-     */
-    reset(): void;
-    /**
-     * Merge old attribute with the attribute from the server.
-     * Readonly attributes always need to show the value from the server
-     */
-    mergeAttribute(oldAttribute: AttributeType): void;
-    /**
-     * Abstract update method which should be implemented on each attribute that has this attribute as a base class.
-     * @abstract
-     */
-    update(value: string, changedAttribute?: AttributeType): AttributeType;
-    /**
-     * Indicate if attribute is editable
-     */
-    set isEditable(arg: boolean);
-    /**
-     * Retrieve if attribute is editable
-     */
-    get isEditable(): boolean;
-    /**
-     * Indicates if the attribute is visible
-     */
-    get isVisible(): boolean;
-    /**
-     */
-    set isHidden(arg: boolean);
-    /**
-     */
-    get isHidden(): boolean;
-    /**
-     * Explicitly toggle visibility of this attribute
-     */
-    show(): void;
-    /**
-     */
-    hide(): void;
-    /**
-     */
-    equals(otherAttribute: AttributeType): boolean;
-    /**
-     * Readonly attribute width indicates the proposed width of this attribute
-     */
-    get readonlyWidth(): $Keys<{
-        EXTRA_SMALL: string;
-        SMALL: string;
-        MEDIUM: string;
-        LARGE: string;
-        EXTRA_LARGE: string;
-    }>;
-    /**
-     */
-    set layoutHintRules(arg: LayoutHintRuleCollection);
-    /**
-     */
-    get layoutHintRules(): LayoutHintRuleCollection;
-    /**
-     */
-    processLayoutHintRules(attributes: AttributeCollection): void;
-    /**
-     * Indicates if content comes from the data service
-     */
-    get hasContentFromData(): boolean;
-    /**
-     */
-    get content(): AttributeContent;
-}
-import BaseModel from "../base/BaseModel";
-import ErrorCollection from "../error/ErrorCollection";
-import ConstraintCollection from "./input-constraints/ConstraintCollection";
-import ConceptDetailModel from "../concepts/ConceptDetailModel";
-import LinkCollection from "../links/LinkCollection";
-import LayoutHintRuleCollection from "./layouthint-rules/LayoutHintRuleCollection";
-import LinkModel from "../links/LinkModel";
-import { ModularUIModel } from "../types";
-import ContentConfiguration from "../contentconfiguration/ContentConfiguration";
-import ContentConfigurationElements from "../contentconfiguration/ContentConfigurationElements";
-import { FormErrorAnchor } from "../types";
-import { MessageParameters } from "../../i18n/types";
-import { AttributeType } from "../types";
-import AttributeCollection from "./AttributeCollection";
-import AttributeContent from "./AttributeContent";
+/**
+ * Attribute model, base model for all kind of attributes
+ */
+export default class AttributeModel extends BaseModel {
+    /**
+     */
+    static isApplicableModel(contributions: Object): boolean;
+    _label: string;
+    _lastModification: number;
+    _initvalue: any;
+    _inputvalue: string;
+    _value: any;
+    _errorCollection: ErrorCollection;
+    _serverConstraints: ConstraintCollection;
+    _useClientsideValidation: boolean;
+    _isValid: boolean;
+    _validatedValue: string | null;
+    _isEditable: boolean;
+    _concept: ConceptDetailModel | null;
+    _referenceDate: ISO_DATE;
+    _isResult: boolean;
+    _isHidden: boolean;
+    _readonly: boolean;
+    _disabled: boolean;
+    _mandatory: boolean;
+    _links: LinkCollection;
+    _parentKey: string | null;
+    _hasContentConfiguration: boolean;
+    _layoutHintRules: LayoutHintRuleCollection;
+    /**
+     * Retrieve initial input value
+     */
+    getInitialInputValue(value: any): any;
+    /**
+     */
+    getInitialChildModelLinks(): Array<LinkModel>;
+    /**
+     */
+    setChildModels(models: Array<ModularUIModel>): void;
+    /**
+     * Set the concept
+     */
+    set concept(arg: ConceptDetailModel);
+    /**
+     * Get concept information
+     */
+    get concept(): ConceptDetailModel;
+    /**
+     * Getting the attribute key
+     */
+    get key(): string;
+    /**
+     */
+    set parentKey(arg: string);
+    /**
+     */
+    get parentKey(): string;
+    /**
+     * Getting the attribute name
+     */
+    get name(): string;
+    /**
+     * Getting the type of the attribute
+     */
+    get type(): string;
+    /**
+     * Set the label of this attribute
+     */
+    set label(arg: string);
+    /**
+     * Getting the label of the attribute
+     */
+    get label(): string;
+    /**
+     */
+    set hasContentConfiguration(arg: boolean);
+    /**
+     */
+    get hasContentConfiguration(): boolean;
+    /**
+     */
+    indicateContentConfiguration(contentConfiguration: ContentConfiguration): void;
+    /**
+     * Retrieve the first permitted label to render when a concept and contentConfiguration is available
+     * Be aware that permission could be in place for labels from a concept.
+     */
+    getContentConfiguredLabel(contentConfiguration: ContentConfigurationElements | null): string;
+    /**
+     */
+    get defaultAlignment(): "center" | "left" | "right";
+    /**
+     * Handles layout hint align-left, align-center and align-right
+     */
+    get alignment(): "center" | "left" | "right";
+    /**
+     * Retrieve links of attribute
+     */
+    get links(): LinkCollection;
+    /**
+     * Retrieve link of attribute when available
+     */
+    get downloadLink(): LinkModel;
+    /**
+     * Retrieve concept link of attribute when available
+     */
+    get conceptLink(): LinkModel;
+    /**
+     * Set reference date for concepts and content
+     */
+    set referenceDate(arg: ISO_DATE);
+    /**
+     * Retrieve reference date of attribute which can be used as entryDate for content
+     * to get information in correct time version
+     */
+    get referenceDate(): ISO_DATE;
+    /**
+     * Initial value received from the modular ui service
+     */
+    get initvalue(): any;
+    /**
+     * Retrieve input value
+     */
+    getInputValue(): string;
+    /**
+     * Sets the input value to the value entered by the user
+     */
+    set inputvalue(arg: string);
+    /**
+     * Returns the value as entered by the user. This can differ from the internal iso value that is stored
+     */
+    get inputvalue(): string;
+    /**
+     * Value that is used when retrieving an error collection of this attribute
+     * Mostly this is the input value, but sometimes a different value is needed,
+     * for example iban and postcode need to validate length without spaces
+     */
+    get validateValue(): string;
+    /**
+     * Setting a value in the element
+     */
+    set value(arg: any);
+    /**
+     * Getting the value of the attribute
+     */
+    get value(): any;
+    /**
+     */
+    hasValue(): boolean;
+    /**
+     * Getting the value of the attribute
+     */
+    getValue(): any;
+    /**
+     * Getting data ready to be send to the modular ui
+     * Returns null when the attribute should not be send to the server
+     */
+    getFormData(): {
+        [string]: any;
+    } | null;
+    /**
+     */
+    get formdata(): {};
+    /**
+     */
+    getEmptyFormData(): {
+        [string]: null;
+    };
+    /**
+     */
+    formatValue(value: string): string;
+    /**
+     * Getting the readonly value, iso value converted for human reading
+     */
+    get readonlyvalue(): string;
+    /**
+     * Set mandatory status of attribute
+     */
+    set mandatory(arg: boolean);
+    /**
+     * Getting mandatory status of attribute
+     */
+    get mandatory(): boolean;
+    /**
+     */
+    get configuredMandatory(): boolean;
+    /**
+     */
+    set readonly(arg: boolean);
+    /**
+     */
+    get readonly(): boolean;
+    /**
+     */
+    set disabled(arg: boolean);
+    /**
+     */
+    get disabled(): boolean;
+    /**
+     */
+    set isResult(arg: boolean);
+    /**
+     */
+    get isResult(): boolean;
+    /**
+     * Getting the display and input format of a attribute
+     */
+    get format(): string;
+    /**
+     */
+    get formatLabel(): string;
+    /**
+     * Get minimum string length
+     */
+    get minLength(): number;
+    /**
+     * Get maximum string length
+     */
+    get maxLength(): number;
+    /**
+     */
+    get operator(): string;
+    /**
+     * Get assistant message
+     */
+    get assistantMessage(): string;
+    /**
+     * Get valid status
+     */
+    get isValid(): boolean;
+    /**
+     * Retrieve applicable constraint for this attribute
+     */
+    get constraintCollection(): ConstraintCollection;
+    /**
+     * Template method for class extending this model to add extra constraints
+     * @abstract
+     */
+    addConstraints(): ConstraintCollection;
+    /**
+     * Used to programmatically overwrite the setting USE_CLIENTSIDE_VALIDATION
+     */
+    setUseClientsideValidation(enabled: boolean): void;
+    /**
+     * Indicates if client side validation is enabled
+     * @returns {boolean}
+     */
+    useClientsideValidation(): boolean;
+    /**
+     * Validate input on client side constraint
+     */
+    validate(value: string): boolean;
+    /**
+     * Indicates if attribute is optional and empty
+     */
+    isOptionalAndEmpty(value: string): boolean;
+    /**
+     * Retrieve error messages of this attribute
+     */
+    get errorCollection(): ErrorCollection;
+    /**
+     * Check if attribute is in error
+     */
+    inError(): boolean;
+    /**
+     * Reset static error messages on attribute
+     */
+    resetErrors(): void;
+    /**
+     * Registers an error that was received from a server response
+     */
+    addServerError(error: FormErrorAnchor): void;
+    /**
+     */
+    removeServerError(id: string): void;
+    /**
+     */
+    hasServerErrors(): boolean;
+    /**
+     */
+    hasErrors(): boolean;
+    /**
+     * Registers a missing error that was received from the server
+     */
+    addMissingError(): void;
+    /**
+     */
+    removeMissingError(): void;
+    /**
+     */
+    addServerConstraint(id: string, defaultMessage?: string, parameters?: MessageParameters): void;
+    /**
+     */
+    formatParameters(parameters: Object): {
+        [string]: string | number;
+    };
+    /**
+     */
+    get hasDynamicValidationData(): boolean;
+    /**
+     */
+    updateValidations(errors: Array<Object>): void;
+    /**
+     * Set last modification to current timestamp
+     */
+    updateLastModification(): void;
+    /**
+     * Inidicates if attribute is changed since a given timestamp (Date.now)
+     */
+    isChangedSince(timestamp: number): boolean;
+    /**
+     * Abstract reset method which should be implemented on each attribute that has this attribute as a base class.
+     *
+     * @abstract
+     */
+    reset(): void;
+    /**
+     * Merge old attribute with the attribute from the server.
+     * Readonly attributes always need to show the value from the server
+     */
+    mergeAttribute(oldAttribute: AttributeType): void;
+    /**
+     * Abstract update method which should be implemented on each attribute that has this attribute as a base class.
+     * @abstract
+     */
+    update(value: string, changedAttribute?: AttributeType): AttributeType;
+    /**
+     * Indicate if attribute is editable
+     */
+    set isEditable(arg: boolean);
+    /**
+     * Retrieve if attribute is editable
+     */
+    get isEditable(): boolean;
+    /**
+     * Indicates if the attribute is visible
+     */
+    get isVisible(): boolean;
+    /**
+     */
+    set isHidden(arg: boolean);
+    /**
+     */
+    get isHidden(): boolean;
+    /**
+     * Explicitly toggle visibility of this attribute
+     */
+    show(): void;
+    /**
+     */
+    hide(): void;
+    /**
+     */
+    equals(otherAttribute: AttributeType): boolean;
+    /**
+     * Readonly attribute width indicates the proposed width of this attribute
+     */
+    get readonlyWidth(): $Keys<{
+        EXTRA_SMALL: string;
+        SMALL: string;
+        MEDIUM: string;
+        LARGE: string;
+        EXTRA_LARGE: string;
+    }>;
+    /**
+     */
+    set layoutHintRules(arg: LayoutHintRuleCollection);
+    /**
+     */
+    get layoutHintRules(): LayoutHintRuleCollection;
+    /**
+     */
+    processLayoutHintRules(attributes: AttributeCollection): void;
+    /**
+     * Indicates if content comes from the data service
+     */
+    get hasContentFromData(): boolean;
+    /**
+     */
+    get content(): AttributeContent;
+}
+import BaseModel from "../base/BaseModel";
+import ErrorCollection from "../error/ErrorCollection";
+import ConstraintCollection from "./input-constraints/ConstraintCollection";
+import ConceptDetailModel from "../concepts/ConceptDetailModel";
+import LinkCollection from "../links/LinkCollection";
+import LayoutHintRuleCollection from "./layouthint-rules/LayoutHintRuleCollection";
+import LinkModel from "../links/LinkModel";
+import { ModularUIModel } from "../types";
+import ContentConfiguration from "../contentconfiguration/ContentConfiguration";
+import ContentConfigurationElements from "../contentconfiguration/ContentConfigurationElements";
+import { FormErrorAnchor } from "../types";
+import { MessageParameters } from "../../i18n/types";
+import { AttributeType } from "../types";
+import AttributeCollection from "./AttributeCollection";
+import AttributeContent from "./AttributeContent";