@itwin/ecschema-metadata 3.6.0-dev.8 → 3.7.0-dev.1

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

@@ -1,153 +1,153 @@
-/** @packageDocumentation
- * @module Metadata
- */
-import { RelationshipClassProps, RelationshipConstraintProps } from "../Deserialization/JsonProps";
-import { ECClassModifier, RelationshipEnd, SchemaItemType, StrengthDirection, StrengthType } from "../ECObjects";
-import { LazyLoadedRelationshipConstraintClass } from "../Interfaces";
-import { ECClass } from "./Class";
-import { CustomAttribute, CustomAttributeContainerProps, CustomAttributeSet } from "./CustomAttribute";
-import { EntityClass } from "./EntityClass";
-import { Mixin } from "./Mixin";
-import { NavigationProperty } from "./Property";
-import { Schema } from "./Schema";
-/**
- * A Typescript class representation of a ECRelationshipClass.
- * @beta
- */
-export declare class RelationshipClass extends ECClass {
-    readonly schema: Schema;
-    readonly schemaItemType: SchemaItemType.RelationshipClass;
-    protected _strength: StrengthType;
-    protected _strengthDirection: StrengthDirection;
-    protected _source: RelationshipConstraint;
-    protected _target: RelationshipConstraint;
-    constructor(schema: Schema, name: string, modifier?: ECClassModifier);
-    get strength(): StrengthType;
-    get strengthDirection(): StrengthDirection;
-    get source(): RelationshipConstraint;
-    get target(): RelationshipConstraint;
-    /**
-     *
-     * @param name
-     * @param relationship
-     * @param direction
-     */
-    protected createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
-    protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
-    /**
-     * @alpha Used for schema editing.
-     */
-    protected setStrength(strength: StrengthType): void;
-    /**
-     * @alpha Used for schema editing.
-     */
-    protected setStrengthDirection(direction: StrengthDirection): void;
-    /**
-     * Save this RelationshipClass's properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): RelationshipClassProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    fromJSONSync(relationshipClassProps: RelationshipClassProps): void;
-    fromJSON(relationshipClassProps: RelationshipClassProps): Promise<void>;
-}
-/**
- * A Typescript class representation of a ECRelationshipConstraint.
- * @beta
- */
-export declare class RelationshipConstraint implements CustomAttributeContainerProps {
-    protected _abstractConstraint?: LazyLoadedRelationshipConstraintClass;
-    protected _relationshipClass: RelationshipClass;
-    protected _relationshipEnd: RelationshipEnd;
-    protected _multiplicity?: RelationshipMultiplicity;
-    protected _polymorphic?: boolean;
-    protected _roleLabel?: string;
-    protected _constraintClasses?: LazyLoadedRelationshipConstraintClass[];
-    private _customAttributes?;
-    constructor(relClass: RelationshipClass, relEnd: RelationshipEnd, roleLabel?: string, polymorphic?: boolean);
-    get multiplicity(): RelationshipMultiplicity | undefined;
-    get polymorphic(): boolean | undefined;
-    get roleLabel(): string | undefined;
-    get constraintClasses(): LazyLoadedRelationshipConstraintClass[] | undefined;
-    get relationshipClass(): RelationshipClass;
-    get relationshipEnd(): RelationshipEnd;
-    get customAttributes(): CustomAttributeSet | undefined;
-    /** Returns the constraint name, ie. 'RelationshipName.Source/Target' */
-    get fullName(): string;
-    /** Returns the schema of the RelationshipClass. */
-    get schema(): Schema;
-    get abstractConstraint(): LazyLoadedRelationshipConstraintClass | undefined;
-    set abstractConstraint(abstractConstraint: LazyLoadedRelationshipConstraintClass | undefined);
-    /**
-     * True if this RelationshipConstraint is the Source relationship end.
-     */
-    get isSource(): boolean;
-    /**
-     * Adds the provided class as a constraint class to this constraint.
-     * @param constraint The class to add as a constraint class.
-     */
-    addClass(constraint: EntityClass | Mixin | RelationshipClass): void;
-    /**
-     * Save this RelationshipConstraint's properties to an object for serializing to JSON.
-     */
-    toJSON(): RelationshipConstraintProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    fromJSONSync(relationshipConstraintProps: RelationshipConstraintProps): void;
-    fromJSON(relationshipConstraintProps: RelationshipConstraintProps): Promise<void>;
-    /**
-     * Indicates if the provided [[ECClass]] is supported by this [[RelationshipConstraint]].
-     * @param ecClass The class to check.
-     */
-    supportsClass(ecClass: ECClass): Promise<boolean>;
-    /**
-     * Indicates if an ECClass is of the type or applies to the type (if a mixin) of the ECClass specified by the constraintClass parameter.
-     * @param constraintClass The ECClass that is a constraint class of a relationship.
-     * @param testClass The ECClass to check against the constraint class.
-     * @param isPolymorphic Indicates if the testClass should be checked polymorphically.
-     */
-    static classCompatibleWithConstraint(constraintClass: ECClass, testClass: ECClass, isPolymorphic: boolean): Promise<boolean>;
-    /**
-     * @internal
-     */
-    static isRelationshipConstraint(object: any): object is RelationshipConstraint;
-    protected addCustomAttribute(customAttribute: CustomAttribute): void;
-}
-/**
- * Hackish approach that works like a "friend class" so we can access protected members without making them public.
- * @internal
- */
-export declare abstract class MutableRelationshipConstraint extends RelationshipConstraint {
-    abstract addCustomAttribute(customAttribute: CustomAttribute): void;
-}
-/**
- * @beta
- */
-export declare class RelationshipMultiplicity {
-    static readonly zeroOne: RelationshipMultiplicity;
-    static readonly zeroMany: RelationshipMultiplicity;
-    static readonly oneOne: RelationshipMultiplicity;
-    static readonly oneMany: RelationshipMultiplicity;
-    readonly lowerLimit: number;
-    readonly upperLimit: number;
-    constructor(lowerLimit: number, upperLimit: number);
-    static fromString(str: string): RelationshipMultiplicity | undefined;
-    equals(rhs: RelationshipMultiplicity): boolean;
-    toString(): string;
-}
-/**
- * @internal
- * An abstract class used for schema editing.
- */
-export declare abstract class MutableRelationshipClass extends RelationshipClass {
-    get source(): MutableRelationshipConstraint;
-    get target(): MutableRelationshipConstraint;
-    abstract setStrength(strength: StrengthType): void;
-    abstract setStrengthDirection(direction: StrengthDirection): void;
-    abstract createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
-    abstract createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
-    abstract setDisplayLabel(displayLabel: string): void;
-}
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { RelationshipClassProps, RelationshipConstraintProps } from "../Deserialization/JsonProps";
+import { ECClassModifier, RelationshipEnd, SchemaItemType, StrengthDirection, StrengthType } from "../ECObjects";
+import { LazyLoadedRelationshipConstraintClass } from "../Interfaces";
+import { ECClass } from "./Class";
+import { CustomAttribute, CustomAttributeContainerProps, CustomAttributeSet } from "./CustomAttribute";
+import { EntityClass } from "./EntityClass";
+import { Mixin } from "./Mixin";
+import { NavigationProperty } from "./Property";
+import { Schema } from "./Schema";
+/**
+ * A Typescript class representation of a ECRelationshipClass.
+ * @beta
+ */
+export declare class RelationshipClass extends ECClass {
+    readonly schema: Schema;
+    readonly schemaItemType: SchemaItemType.RelationshipClass;
+    protected _strength: StrengthType;
+    protected _strengthDirection: StrengthDirection;
+    protected _source: RelationshipConstraint;
+    protected _target: RelationshipConstraint;
+    constructor(schema: Schema, name: string, modifier?: ECClassModifier);
+    get strength(): StrengthType;
+    get strengthDirection(): StrengthDirection;
+    get source(): RelationshipConstraint;
+    get target(): RelationshipConstraint;
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     */
+    protected createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+    protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
+    /**
+     * @alpha Used for schema editing.
+     */
+    protected setStrength(strength: StrengthType): void;
+    /**
+     * @alpha Used for schema editing.
+     */
+    protected setStrengthDirection(direction: StrengthDirection): void;
+    /**
+     * Save this RelationshipClass's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): RelationshipClassProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(relationshipClassProps: RelationshipClassProps): void;
+    fromJSON(relationshipClassProps: RelationshipClassProps): Promise<void>;
+}
+/**
+ * A Typescript class representation of a ECRelationshipConstraint.
+ * @beta
+ */
+export declare class RelationshipConstraint implements CustomAttributeContainerProps {
+    protected _abstractConstraint?: LazyLoadedRelationshipConstraintClass;
+    protected _relationshipClass: RelationshipClass;
+    protected _relationshipEnd: RelationshipEnd;
+    protected _multiplicity?: RelationshipMultiplicity;
+    protected _polymorphic?: boolean;
+    protected _roleLabel?: string;
+    protected _constraintClasses?: LazyLoadedRelationshipConstraintClass[];
+    private _customAttributes?;
+    constructor(relClass: RelationshipClass, relEnd: RelationshipEnd, roleLabel?: string, polymorphic?: boolean);
+    get multiplicity(): RelationshipMultiplicity | undefined;
+    get polymorphic(): boolean | undefined;
+    get roleLabel(): string | undefined;
+    get constraintClasses(): LazyLoadedRelationshipConstraintClass[] | undefined;
+    get relationshipClass(): RelationshipClass;
+    get relationshipEnd(): RelationshipEnd;
+    get customAttributes(): CustomAttributeSet | undefined;
+    /** Returns the constraint name, ie. 'RelationshipName.Source/Target' */
+    get fullName(): string;
+    /** Returns the schema of the RelationshipClass. */
+    get schema(): Schema;
+    get abstractConstraint(): LazyLoadedRelationshipConstraintClass | undefined;
+    set abstractConstraint(abstractConstraint: LazyLoadedRelationshipConstraintClass | undefined);
+    /**
+     * True if this RelationshipConstraint is the Source relationship end.
+     */
+    get isSource(): boolean;
+    /**
+     * Adds the provided class as a constraint class to this constraint.
+     * @param constraint The class to add as a constraint class.
+     */
+    addClass(constraint: EntityClass | Mixin | RelationshipClass): void;
+    /**
+     * Save this RelationshipConstraint's properties to an object for serializing to JSON.
+     */
+    toJSON(): RelationshipConstraintProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(relationshipConstraintProps: RelationshipConstraintProps): void;
+    fromJSON(relationshipConstraintProps: RelationshipConstraintProps): Promise<void>;
+    /**
+     * Indicates if the provided [[ECClass]] is supported by this [[RelationshipConstraint]].
+     * @param ecClass The class to check.
+     */
+    supportsClass(ecClass: ECClass): Promise<boolean>;
+    /**
+     * Indicates if an ECClass is of the type or applies to the type (if a mixin) of the ECClass specified by the constraintClass parameter.
+     * @param constraintClass The ECClass that is a constraint class of a relationship.
+     * @param testClass The ECClass to check against the constraint class.
+     * @param isPolymorphic Indicates if the testClass should be checked polymorphically.
+     */
+    static classCompatibleWithConstraint(constraintClass: ECClass, testClass: ECClass, isPolymorphic: boolean): Promise<boolean>;
+    /**
+     * @internal
+     */
+    static isRelationshipConstraint(object: any): object is RelationshipConstraint;
+    protected addCustomAttribute(customAttribute: CustomAttribute): void;
+}
+/**
+ * Hackish approach that works like a "friend class" so we can access protected members without making them public.
+ * @internal
+ */
+export declare abstract class MutableRelationshipConstraint extends RelationshipConstraint {
+    abstract addCustomAttribute(customAttribute: CustomAttribute): void;
+}
+/**
+ * @beta
+ */
+export declare class RelationshipMultiplicity {
+    static readonly zeroOne: RelationshipMultiplicity;
+    static readonly zeroMany: RelationshipMultiplicity;
+    static readonly oneOne: RelationshipMultiplicity;
+    static readonly oneMany: RelationshipMultiplicity;
+    readonly lowerLimit: number;
+    readonly upperLimit: number;
+    constructor(lowerLimit: number, upperLimit: number);
+    static fromString(str: string): RelationshipMultiplicity | undefined;
+    equals(rhs: RelationshipMultiplicity): boolean;
+    toString(): string;
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableRelationshipClass extends RelationshipClass {
+    get source(): MutableRelationshipConstraint;
+    get target(): MutableRelationshipConstraint;
+    abstract setStrength(strength: StrengthType): void;
+    abstract setStrengthDirection(direction: StrengthDirection): void;
+    abstract createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+    abstract createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
 //# sourceMappingURL=RelationshipClass.d.ts.map