Základné informácie

• Predpokladom pochopenia OBERON API je aspoň základná znalosť objektového programovania. Osoby, ktoré majú aj minimálne skúsenosti s programovaním (prípadne aj v iných programovacích jazykoch), zvládnu danú problematiku pomerne rýchlo.
• Predpokladom zoznámenia sa so základami OBERON API je oboznámiť sa s témou Príprava vývojového prostredia pre OBERON API .
• Základy budú opísané na príklade exportu skladových kariet do textového súboru - odporúčame mať spustený editor Microsoft Visual Studio 2019 (alebo novší) a otvorený projekt daného príkladu.

 

Príklad programového kódu:

PrivateSub btn_Exportovat_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btn_Exportovat.Click

      '--- Deklarácia objektov  
      Dim tmp_AppOBERON As Exa.OBERON.Application.API.AppEngine = Nothing 
Nothing      Dim myEx As Exa.Basic.Exceptions.ExaException = Nothing

      '--------------------------------------------
      '--- Úvodná inicializácia aplikácie ---
      '--------------------------------------------

      '--- Vytvorenie objektu aplikácie OBERON
      tmp_AppOBERON = New Exa.OBERON.Application.API.AppEngine()    
      myEx = tmp_AppOBERON.App_Initialize()
      If myEx.Result = False Then
            '--- Chyba spustenia
            txt_Status.Text = myEx.Description
            GoTo ExitSub
      End If

      '--------------------------------------------
      '--- Nastavenie firmy ktorá sa má otvoriť ---
      '--------------------------------------------

      Dim tmp_CompanySettings As New Exa.OBERON.ApplicationEnvironment.CompanyOpenSettings

     
'--- Mód spustenia - pri tomto nastavení sa napr. neinicializujú pripojené zariadenia ako snímač čiarových kódov      tmp_CompanySettings.Application_Mode = Exa.OBERON.ApplicationEnvironment.CompanyOpenSettings.enum_Application_Mode.OBERON_Center     
      tmp_CompanySettings.Application_UserName = txt_UzivatelMeno.Text    '--- Prihlasovacie meno do OBERON-u     
      tmp_CompanySettings.Application_Password = txt_UzivatelHeslo.Text  '--- Prihlasovacie heslo do OBERON-u      
      tmp_CompanySettings._ConnectionSettings.DataSourceType = Exa.Database.enm_DataSourceTypes.MicrosoftAccessOleDB_1997   '--- Typ databázy, napr. MDB, prípadne SQL server
      tmp_CompanySettings._ConnectionSettings.ConnectionString.Database = txt_Databaza.Text   '--- Databáza MDB ktorá sa má otvoriť

      '--- Otvorenie firmy 
      myEx = tmp_AppOBERON.Company_Open(tmp_CompanySettings) 
      If myEx.Result = False Then
            '--- Chyba otvorenia firmy
'--- Chyba otvorenia firmy            txt_Status.Text = txt_Status.Text & vbCrLf & myEx.Description
            GoTo ExitSub
      End If

      '-------------------------------------------------------------
      '--- Firma bola úspešne otvorená - je možné začať pracovať ---
      '-------------------------------------------------------------

  .... programový kód pre už konkrétnu činnosť 

ExitSub:

      '--- Zatvorenie firmy ---
      If tmp_AppOBERON.IsCompanyOpen = True Then
            tmp_AppOBERON.Company_Close()
      End If
      tmp_AppOBERON.Dispose

EndSub

 

Všeobecný komentár k zdrojovému kódu

• Zelenou farbou je uvedený základný komentár k zdrojovému textu, modrou sú uvedené tzv. klúčové slová vývojového prostredia - farebné rozlíšenie podstatne zvyšuje čitateľnosť kódu.
• Aby bolo možné pristupovať k databázovým údajom konkrétnej firmy, je potrebné vytvoriť základný objekt aplikácie Exa.OBERON.Application.AppEngine.  Obsahuje funkcie pre otvorenie databázy danej firmy (Company_Open), taktiež rutiny pre prihlásenie používateľa (a overenie prístupových práv), načíta nastavenia firmy, inicializuje pripojiteľné zariadenia (napr. snímač čiarových kódov) a pod.
• Až po otvorení firmy je možné pracovať s údajmi. Pred ukončením programového kódu je potrebné volať funkciu (Company_Close), ktorá korektne odhlási používateľa, pozatvára databázové objekty a ukončí beh základného programu.
• Ak je firma otvorená, je možné volať ďalšie OBERON API, ktoré vykonajú požadovanú činnosť. OBERON API sa nachádzajú v mennom priestore (Namespace) EXA.
• Väčšina funkcií vracia návratovú hodnotu objekt Exa.Basic.Exceptions.ExaException . Obsahuje vlastnosť Result, ktorá informuje či funkcia bola úspešná (vtedy nadobúda hodnotu True ). Ak dôjde vo volanej funkcii k chybe, vo vlastnosti Description sa nachádza text danej chyby.