@itwin/ecschema-metadata 3.6.0-dev.36 → 3.6.0-dev.38

package/lib/cjs/Metadata/Property.d.ts

@@ -1,198 +1,198 @@
-/** @packageDocumentation
- * @module Metadata
- */
-import { EnumerationPropertyProps, NavigationPropertyProps, PrimitiveArrayPropertyProps, PrimitiveOrEnumPropertyBaseProps, PrimitivePropertyProps, PropertyProps, StructPropertyProps } from "../Deserialization/JsonProps";
-import { PrimitiveType, StrengthDirection } from "../ECObjects";
-import { AnyClass, LazyLoadedEnumeration, LazyLoadedKindOfQuantity, LazyLoadedPropertyCategory, LazyLoadedRelationshipClass } from "../Interfaces";
-import { PropertyType } from "../PropertyTypes";
-import { ECName } from "../ECName";
-import { ECClass, StructClass } from "./Class";
-import { CustomAttribute, CustomAttributeContainerProps, CustomAttributeSet } from "./CustomAttribute";
-import { KindOfQuantity } from "./KindOfQuantity";
-import { PropertyCategory } from "./PropertyCategory";
-import { RelationshipClass } from "./RelationshipClass";
-import { Schema } from "./Schema";
-/**
- * A common abstract class for all ECProperty types.
- * @beta
- */
-export declare abstract class Property implements CustomAttributeContainerProps {
-    protected _name: ECName;
-    protected _type: PropertyType;
-    protected _class: AnyClass;
-    protected _description?: string;
-    protected _label?: string;
-    protected _isReadOnly?: boolean;
-    protected _priority?: number;
-    protected _category?: LazyLoadedPropertyCategory;
-    protected _kindOfQuantity?: LazyLoadedKindOfQuantity;
-    private _customAttributes?;
-    constructor(ecClass: ECClass, name: string, type: PropertyType);
-    isArray(): this is AnyArrayProperty;
-    isPrimitive(): this is AnyPrimitiveProperty;
-    isStruct(): this is AnyStructProperty;
-    isEnumeration(): this is AnyEnumerationProperty;
-    isNavigation(): this is NavigationProperty;
-    get name(): string;
-    get class(): AnyClass;
-    get label(): string | undefined;
-    get description(): string | undefined;
-    get isReadOnly(): boolean;
-    get priority(): number;
-    get category(): LazyLoadedPropertyCategory | undefined;
-    get kindOfQuantity(): LazyLoadedKindOfQuantity | undefined;
-    get propertyType(): PropertyType;
-    get customAttributes(): CustomAttributeSet | undefined;
-    /** Returns the name in the format 'ClassName.PropertyName'. */
-    get fullName(): string;
-    /** Returns the schema of the class holding the property. */
-    get schema(): Schema;
-    getCategorySync(): PropertyCategory | undefined;
-    getKindOfQuantitySync(): KindOfQuantity | undefined;
-    /**
-     * Save this Property's properties to an object for serializing to JSON.
-     */
-    toJSON(): PropertyProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    fromJSONSync(propertyProps: PropertyProps): void;
-    fromJSON(propertyProps: PropertyProps): Promise<void>;
-    protected addCustomAttribute(customAttribute: CustomAttribute): void;
-    /**
-     * Retrieve all custom attributes in the current property and its base
-     * This is the async version of getCustomAttributesSync()
-     */
-    getCustomAttributes(): Promise<CustomAttributeSet>;
-    /**
-     * Retrieve all custom attributes in the current property and its base.
-     */
-    getCustomAttributesSync(): CustomAttributeSet;
-    /**
-     * @internal
-     */
-    static isProperty(object: any): object is Property;
-}
-/** @beta */
-export declare abstract class PrimitiveOrEnumPropertyBase extends Property {
-    protected _extendedTypeName?: string;
-    protected _minLength?: number;
-    protected _maxLength?: number;
-    protected _minValue?: number;
-    protected _maxValue?: number;
-    get extendedTypeName(): string | undefined;
-    get minLength(): number | undefined;
-    get maxLength(): number | undefined;
-    get minValue(): number | undefined;
-    get maxValue(): number | undefined;
-    constructor(ecClass: ECClass, name: string, type: PropertyType);
-    /**
-     * Save this PrimitiveOrEnumPropertyBase's properties to an object for serializing to JSON.
-     */
-    toJSON(): PrimitiveOrEnumPropertyBaseProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    fromJSONSync(propertyBaseProps: PrimitiveOrEnumPropertyBaseProps): void;
-    fromJSON(propertyBaseProps: PrimitiveOrEnumPropertyBaseProps): Promise<void>;
-}
-/** @beta */
-export declare class PrimitiveProperty extends PrimitiveOrEnumPropertyBase {
-    get primitiveType(): PrimitiveType;
-    constructor(ecClass: ECClass, name: string, primitiveType?: PrimitiveType);
-    fromJSONSync(primitivePropertyProps: PrimitivePropertyProps): void;
-    fromJSON(primitivePropertyProps: PrimitivePropertyProps): Promise<void>;
-    /**
-     * Save this PrimitiveProperty's properties to an object for serializing to JSON.
-     */
-    toJSON(): PrimitivePropertyProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-}
-/** @beta */
-export declare class EnumerationProperty extends PrimitiveOrEnumPropertyBase {
-    protected _enumeration?: LazyLoadedEnumeration;
-    get enumeration(): LazyLoadedEnumeration | undefined;
-    /**
-     * Save this EnumerationProperty's properties to an object for serializing to JSON.
-     */
-    toJSON(): EnumerationPropertyProps;
-    constructor(ecClass: ECClass, name: string, type: LazyLoadedEnumeration);
-    fromJSONSync(enumerationPropertyProps: EnumerationPropertyProps): void;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    fromJSON(enumerationPropertyProps: EnumerationPropertyProps): Promise<void>;
-}
-/** @beta */
-export declare class StructProperty extends Property {
-    protected _structClass: StructClass;
-    get structClass(): StructClass;
-    constructor(ecClass: ECClass, name: string, type: StructClass);
-    /**
-     * Save this StructProperty's properties to an object for serializing to JSON.
-     */
-    toJSON(): StructPropertyProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    fromJSONSync(structPropertyProps: StructPropertyProps): void;
-    fromJSON(structPropertyProps: StructPropertyProps): Promise<void>;
-}
-/** @beta */
-export declare class NavigationProperty extends Property {
-    protected _relationshipClass: LazyLoadedRelationshipClass;
-    protected _direction: StrengthDirection;
-    get relationshipClass(): LazyLoadedRelationshipClass;
-    getRelationshipClassSync(): RelationshipClass | undefined;
-    get direction(): StrengthDirection;
-    /**
-     * Save this NavigationProperty's properties to an object for serializing to JSON.
-     */
-    toJSON(): NavigationPropertyProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    constructor(ecClass: ECClass, name: string, relationship: LazyLoadedRelationshipClass, direction?: StrengthDirection);
-}
-declare type Constructor<T> = new (...args: any[]) => T;
-/** @beta */
-export declare abstract class ArrayProperty extends Property {
-    protected _minOccurs: number;
-    protected _maxOccurs?: number;
-    get minOccurs(): number;
-    get maxOccurs(): number | undefined;
-}
-declare const PrimitiveArrayProperty_base: typeof PrimitiveProperty & Constructor<ArrayProperty>;
-/** @beta */
-export declare class PrimitiveArrayProperty extends PrimitiveArrayProperty_base {
-    constructor(ecClass: ECClass, name: string, primitiveType?: PrimitiveType);
-    /**
-     * Save this PrimitiveArrayProperty's properties to an object for serializing to JSON.
-     */
-    toJSON(): PrimitiveArrayPropertyProps;
-}
-declare const EnumerationArrayProperty_base: typeof EnumerationProperty & Constructor<ArrayProperty>;
-/** @beta */
-export declare class EnumerationArrayProperty extends EnumerationArrayProperty_base {
-    constructor(ecClass: ECClass, name: string, type: LazyLoadedEnumeration);
-}
-declare const StructArrayProperty_base: typeof StructProperty & Constructor<ArrayProperty>;
-/** @beta */
-export declare class StructArrayProperty extends StructArrayProperty_base {
-    constructor(ecClass: ECClass, name: string, type: StructClass);
-}
-/** @beta */
-export declare type AnyArrayProperty = PrimitiveArrayProperty | EnumerationArrayProperty | StructArrayProperty;
-/** @beta */
-export declare type AnyPrimitiveProperty = PrimitiveProperty | PrimitiveArrayProperty;
-/** @beta */
-export declare type AnyEnumerationProperty = EnumerationProperty | EnumerationArrayProperty;
-/** @beta */
-export declare type AnyStructProperty = StructProperty | StructArrayProperty;
-/** @beta */
-export declare type AnyProperty = AnyPrimitiveProperty | AnyEnumerationProperty | AnyStructProperty | NavigationProperty;
-/**
- * Hackish approach that works like a "friend class" so we can access protected members without making them public.
- * @internal
- */
-export declare abstract class MutableProperty extends Property {
-    abstract addCustomAttribute(customAttribute: CustomAttribute): void;
-}
-export {};
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { EnumerationPropertyProps, NavigationPropertyProps, PrimitiveArrayPropertyProps, PrimitiveOrEnumPropertyBaseProps, PrimitivePropertyProps, PropertyProps, StructPropertyProps } from "../Deserialization/JsonProps";
+import { PrimitiveType, StrengthDirection } from "../ECObjects";
+import { AnyClass, LazyLoadedEnumeration, LazyLoadedKindOfQuantity, LazyLoadedPropertyCategory, LazyLoadedRelationshipClass } from "../Interfaces";
+import { PropertyType } from "../PropertyTypes";
+import { ECName } from "../ECName";
+import { ECClass, StructClass } from "./Class";
+import { CustomAttribute, CustomAttributeContainerProps, CustomAttributeSet } from "./CustomAttribute";
+import { KindOfQuantity } from "./KindOfQuantity";
+import { PropertyCategory } from "./PropertyCategory";
+import { RelationshipClass } from "./RelationshipClass";
+import { Schema } from "./Schema";
+/**
+ * A common abstract class for all ECProperty types.
+ * @beta
+ */
+export declare abstract class Property implements CustomAttributeContainerProps {
+    protected _name: ECName;
+    protected _type: PropertyType;
+    protected _class: AnyClass;
+    protected _description?: string;
+    protected _label?: string;
+    protected _isReadOnly?: boolean;
+    protected _priority?: number;
+    protected _category?: LazyLoadedPropertyCategory;
+    protected _kindOfQuantity?: LazyLoadedKindOfQuantity;
+    private _customAttributes?;
+    constructor(ecClass: ECClass, name: string, type: PropertyType);
+    isArray(): this is AnyArrayProperty;
+    isPrimitive(): this is AnyPrimitiveProperty;
+    isStruct(): this is AnyStructProperty;
+    isEnumeration(): this is AnyEnumerationProperty;
+    isNavigation(): this is NavigationProperty;
+    get name(): string;
+    get class(): AnyClass;
+    get label(): string | undefined;
+    get description(): string | undefined;
+    get isReadOnly(): boolean;
+    get priority(): number;
+    get category(): LazyLoadedPropertyCategory | undefined;
+    get kindOfQuantity(): LazyLoadedKindOfQuantity | undefined;
+    get propertyType(): PropertyType;
+    get customAttributes(): CustomAttributeSet | undefined;
+    /** Returns the name in the format 'ClassName.PropertyName'. */
+    get fullName(): string;
+    /** Returns the schema of the class holding the property. */
+    get schema(): Schema;
+    getCategorySync(): PropertyCategory | undefined;
+    getKindOfQuantitySync(): KindOfQuantity | undefined;
+    /**
+     * Save this Property's properties to an object for serializing to JSON.
+     */
+    toJSON(): PropertyProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(propertyProps: PropertyProps): void;
+    fromJSON(propertyProps: PropertyProps): Promise<void>;
+    protected addCustomAttribute(customAttribute: CustomAttribute): void;
+    /**
+     * Retrieve all custom attributes in the current property and its base
+     * This is the async version of getCustomAttributesSync()
+     */
+    getCustomAttributes(): Promise<CustomAttributeSet>;
+    /**
+     * Retrieve all custom attributes in the current property and its base.
+     */
+    getCustomAttributesSync(): CustomAttributeSet;
+    /**
+     * @internal
+     */
+    static isProperty(object: any): object is Property;
+}
+/** @beta */
+export declare abstract class PrimitiveOrEnumPropertyBase extends Property {
+    protected _extendedTypeName?: string;
+    protected _minLength?: number;
+    protected _maxLength?: number;
+    protected _minValue?: number;
+    protected _maxValue?: number;
+    get extendedTypeName(): string | undefined;
+    get minLength(): number | undefined;
+    get maxLength(): number | undefined;
+    get minValue(): number | undefined;
+    get maxValue(): number | undefined;
+    constructor(ecClass: ECClass, name: string, type: PropertyType);
+    /**
+     * Save this PrimitiveOrEnumPropertyBase's properties to an object for serializing to JSON.
+     */
+    toJSON(): PrimitiveOrEnumPropertyBaseProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(propertyBaseProps: PrimitiveOrEnumPropertyBaseProps): void;
+    fromJSON(propertyBaseProps: PrimitiveOrEnumPropertyBaseProps): Promise<void>;
+}
+/** @beta */
+export declare class PrimitiveProperty extends PrimitiveOrEnumPropertyBase {
+    get primitiveType(): PrimitiveType;
+    constructor(ecClass: ECClass, name: string, primitiveType?: PrimitiveType);
+    fromJSONSync(primitivePropertyProps: PrimitivePropertyProps): void;
+    fromJSON(primitivePropertyProps: PrimitivePropertyProps): Promise<void>;
+    /**
+     * Save this PrimitiveProperty's properties to an object for serializing to JSON.
+     */
+    toJSON(): PrimitivePropertyProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+}
+/** @beta */
+export declare class EnumerationProperty extends PrimitiveOrEnumPropertyBase {
+    protected _enumeration?: LazyLoadedEnumeration;
+    get enumeration(): LazyLoadedEnumeration | undefined;
+    /**
+     * Save this EnumerationProperty's properties to an object for serializing to JSON.
+     */
+    toJSON(): EnumerationPropertyProps;
+    constructor(ecClass: ECClass, name: string, type: LazyLoadedEnumeration);
+    fromJSONSync(enumerationPropertyProps: EnumerationPropertyProps): void;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSON(enumerationPropertyProps: EnumerationPropertyProps): Promise<void>;
+}
+/** @beta */
+export declare class StructProperty extends Property {
+    protected _structClass: StructClass;
+    get structClass(): StructClass;
+    constructor(ecClass: ECClass, name: string, type: StructClass);
+    /**
+     * Save this StructProperty's properties to an object for serializing to JSON.
+     */
+    toJSON(): StructPropertyProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(structPropertyProps: StructPropertyProps): void;
+    fromJSON(structPropertyProps: StructPropertyProps): Promise<void>;
+}
+/** @beta */
+export declare class NavigationProperty extends Property {
+    protected _relationshipClass: LazyLoadedRelationshipClass;
+    protected _direction: StrengthDirection;
+    get relationshipClass(): LazyLoadedRelationshipClass;
+    getRelationshipClassSync(): RelationshipClass | undefined;
+    get direction(): StrengthDirection;
+    /**
+     * Save this NavigationProperty's properties to an object for serializing to JSON.
+     */
+    toJSON(): NavigationPropertyProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    constructor(ecClass: ECClass, name: string, relationship: LazyLoadedRelationshipClass, direction?: StrengthDirection);
+}
+declare type Constructor<T> = new (...args: any[]) => T;
+/** @beta */
+export declare abstract class ArrayProperty extends Property {
+    protected _minOccurs: number;
+    protected _maxOccurs?: number;
+    get minOccurs(): number;
+    get maxOccurs(): number | undefined;
+}
+declare const PrimitiveArrayProperty_base: typeof PrimitiveProperty & Constructor<ArrayProperty>;
+/** @beta */
+export declare class PrimitiveArrayProperty extends PrimitiveArrayProperty_base {
+    constructor(ecClass: ECClass, name: string, primitiveType?: PrimitiveType);
+    /**
+     * Save this PrimitiveArrayProperty's properties to an object for serializing to JSON.
+     */
+    toJSON(): PrimitiveArrayPropertyProps;
+}
+declare const EnumerationArrayProperty_base: typeof EnumerationProperty & Constructor<ArrayProperty>;
+/** @beta */
+export declare class EnumerationArrayProperty extends EnumerationArrayProperty_base {
+    constructor(ecClass: ECClass, name: string, type: LazyLoadedEnumeration);
+}
+declare const StructArrayProperty_base: typeof StructProperty & Constructor<ArrayProperty>;
+/** @beta */
+export declare class StructArrayProperty extends StructArrayProperty_base {
+    constructor(ecClass: ECClass, name: string, type: StructClass);
+}
+/** @beta */
+export declare type AnyArrayProperty = PrimitiveArrayProperty | EnumerationArrayProperty | StructArrayProperty;
+/** @beta */
+export declare type AnyPrimitiveProperty = PrimitiveProperty | PrimitiveArrayProperty;
+/** @beta */
+export declare type AnyEnumerationProperty = EnumerationProperty | EnumerationArrayProperty;
+/** @beta */
+export declare type AnyStructProperty = StructProperty | StructArrayProperty;
+/** @beta */
+export declare type AnyProperty = AnyPrimitiveProperty | AnyEnumerationProperty | AnyStructProperty | NavigationProperty;
+/**
+ * Hackish approach that works like a "friend class" so we can access protected members without making them public.
+ * @internal
+ */
+export declare abstract class MutableProperty extends Property {
+    abstract addCustomAttribute(customAttribute: CustomAttribute): void;
+}
+export {};
 //# sourceMappingURL=Property.d.ts.map