Sage-ST

Sage-ST ä
Basicschemaclass
Documentation

Unit Documentation (Unit description) Global Declarations (Constants, Types, Variables)



  //*
  //  BasicSchemaClass - Basic class object for a SageST schema.
  //
  //
  //  This unit provides the structure to access a SageST schema in a class
  //  manner.  Once an object has been created of this class the routines
  //  typically used to control and get information about a schema are
  //  available using the object.
  //



  type
    KeyedFieldType = (NonKey,
                      PrimaryKey,
                      AlternateKey);

    ESageSTSchema = class (SysUtils.Exception);

    //
    // TBasicSchemaClass - Opens the schema (DFL) and retrieves information about it.
    //

    TBasicSchemaClass = class

      private
        FDflPathAndName : string;

        FSystemNumber : ModSys.INT32;

        FSageError : cardinal;

      public

        constructor Create
                   (const DFLSpec  : string;
                    const Password : string); virtual;

        //*
        //  Create - Create a basic Schema Object.
        //
        //
        //  This routine will create a SageST schema object that will provide
        //  an object interface to schema related routines such as OpenSystem
        //  and CloseSystem.
        //
        //  CALLING SEQUENCE -
        //
        //    MySchema := BasicSchemaClass.TBasicSchemaClass.Create (DflSpec,
        //                                                           Password);
        //
        //  ENTRY -
        //
        //    DflSpec : string
        //      The name of the Dfl to open with or without the optional path.
        //
        //    Password : string
        //      A password if one is required to open the dfl.
        //

        destructor Destroy; override;

        //*
        //  Destroy - Destroy the current Basic Schema Object.
        //
        //
        //  This routine will destroy the SageST schema object that was created
        //  when the Create routine was called.
        //
        //  CALLING SEQUENCE -
        //
        //    MySchema.Free;
        //

        procedure SetSageError
                   (const err : cardinal); virtual;

        function SageError
                   () : cardinal; virtual;

        function SystemIsOpen
                   (const Dictionary : string) : boolean; virtual;

        procedure SetPW
                   (const Password : string); virtual;

        property SchemaError : cardinal
          read FSageError;

        //*
        //  SchemaSageError - Returns last SageError from the operations
        //  of this class.
        //

        property DflPathAndName : string
          read FDflPathAndName;

        //*
        //  DFLPathAndName - Returns the path and name of opened schema (DFL).
        //

        property systemNumber : ModSys.INT32
          read FSystemNumber;

        //*
        //  SystemNumber - Returns the current system number.
        //
    end;