import { IEntityController } from './IEntityController';
import { IStorageRefOptions } from './IStorageRefOptions';
import { ClassType, IClassRef, IEntityRef, ILookupRegistry, ISchemaRef } from '@allgemein/schema-api';
import { IConnection } from './IConnection';
import { ICollection } from './ICollection';
/**
 * Abstract interface for storage declaration
 */
export interface IStorageRef {
    /**
     * returns the name
     */
    getName(): string;
    /**
     * return storage framework
     */
    getFramework(): string;
    /**
     * return storage type
     */
    getType(): string;
    /**
     * Return generic entity controller
     */
    getController(): IEntityController;
    /**
     * Return lookup registry
     */
    getRegistry(): ILookupRegistry;
    /**
     * return storage options
     */
    getOptions(): IStorageRefOptions;
    /**
     * implements initialisation for storage ref, called after constructor
     */
    initialize?(): boolean | Promise<boolean>;
    /**
     * implements initialisation for storage ref, called after constructor
     */
    prepare(): boolean | Promise<boolean>;
    /**
     * check if class is handled by this storage ref
     *
     * @param cls
     */
    hasEntityClass(cls: string | Function | IClassRef): boolean;
    /**
     * add a new class to schema
     *
     * @param type
     */
    addEntityClass?(type: Function | IClassRef | ClassType<any>, options?: any): void;
    /**
     * Open a direct connection
     */
    connect(): Promise<IConnection>;
    /**
     * onShutdown function to finalize this storage ref (close opened connection and release resources)
     *
     * @param full - marks if onShutdown is soft (close on runtime) or hard (onShutdown of program)
     */
    shutdown(full?: boolean): void;
    /**
     * add storage ref which is extended by this
     *
     * @param ref
     */
    addExtendedStorageRef(ref: IStorageRef): void;
    /**
     * add storage ref which extending an other
     *
     * @param ref
     */
    addExtendingStorageRef(extRef: IStorageRef): void;
    /**
     * Returns IEntityRef handled by the storage
     *
     * @param name
     */
    getEntityRef(name: string | Function): IEntityRef | IEntityRef[];
    /**
     * Return all handled entities
     */
    getEntityRefs(): IEntityRef[];
    /**
     * Returns used SchemaRef if supported by this storage ref
     *
     * @param name
     */
    getSchemaRef(name: string): ISchemaRef;
    /**
     * Returns used SchemaRefs by this storage
     */
    getSchemaRefs(): ISchemaRef[];
    /**
     * Return configured entities
     */
    getDeclaredEntities(): Function[];
    /**
     * Return all handled entity ames
     */
    getEntityNames(): string[];
    /**
     * Return all collection names handled by this storage ref
     */
    getRawCollectionNames(): string[] | Promise<string[]>;
    /**
     * Return all collection descriptions handled by this storage ref
     */
    getRawCollections(collectionNames: string[]): ICollection[] | Promise<ICollection[]>;
    /**
     * Return a collection description handled by this storage ref by name
     */
    getRawCollection(name: string): ICollection | Promise<ICollection>;
    /**
     * Reload storage configuration
     */
    reload(): Promise<boolean> | boolean;
    /**
     * Test if storage ref is already connected
     */
    isActive(): boolean;
}