API modulu projektu Caddis

Spravce dat:

Funkce Vstup Výstup Popis Poznámky
GetData
typtyp hledaných dat
popispopis hledaných dat(napríklad filtry na shodu podretezcu, konkrétní nápln je závislá na typu dat)
sidsession id - pro kontrolu zda muze uzivatel tato data císt, atp...
seznam odpovídajících záznamu Obecná funkce pro vyhledávání dat jakéhokoliv typu
PutData
operacejedna z operací SELECT, UPDATE, DELETE
typtyp vstupních dat
datasamotná data k ulo?ení(data by mela být typu zadaného jako první parametr)
sidsession id - pro kontrolu zda muze uzivatel tato data zapisovat, atp...
klíc opraveného záznamu Obecná funkce pro zápis dat jakéhokoliv typu
PutForm
operacejedna z operací SELECT, UPDATE, DELETE
datadata k ulo?ení
validitavalidita vstupních dat - zda se jedná o do?asná data(neprosla kontrolou) nebo platná data(byla zkontrolována)
sidsession id - pro kontrolu zda muze uzivatel tato data zapisovat, atp...
klíc opraveného záznamu Funkce pro zapis vstupu od u?ivatele Tato funkce je redundantni - slo by pouzit funkci PutData s odpovidajicim typem, ale myslim, ze pro programovaní modulu to není ?ádná práce navíc a specializované funkce mohou prispet k zprehledneni ostatnich modulu.
GetForm
popispopis dat, která hledáme (napr.: popis uzivatele a cástecne vyplneny formular)
sidsession id - pro kontrolu zda muze uzivatel tato data zapisovat, atp...
seznam odpovídajících záznamu Funkce pro ctení dríve ulozených uzivatelských vstupu Tato funkce je redundantni - slo by pouzit funkci GetData s odpovidajicim typem, ale myslim, ze pro programovaní modulu to není ?ádná práce navíc a specializované funkce mohou prispet k zprehledneni ostatnich modulu.
Login
uzivateluzivatelské jméno
hesloheslo pro daného uzivatele
sidsession id - cislo identifikujici pozdeji sezeni zalogovaneho uzivatele
popispopis uzivatele: napr. jeho prave - tento vystup je mozna zbytecný
zunkce zaloguje uzivatele identifikovaného jménem a heslem. Pro "logování" autor? (omezením ip-adres) by slo zavést speciálního uzuvatele autor s prazdným heslem u kterého by se kontrolovala ip-adresa
Logout
sidsession id, které se má odhlásit
zádný funkce odloguje uzivatele identifikovaného cislem sid.
IsLogged
uzivatel nebo sididentifikace uzivatele
true/falsezda je uzivatel zalogovan
popispopis uzivatele: napr. jeho prava
funkce overí zda je uzivatel zalogovan. funkce muze byt take pouzita pro zjisteni informaci o uzivateli

Tester:

Funkce Vstup Výstup Popis Poznámky
Kontrola
Formulárdata získaná o uzivatele
typ formuláreschéma formulare, ktere se ma pouzit pro kontrolu a zpracování dat
sidsession id = pro kontrolu oprávnení
chyby v datechpopis chyb v datech - data od uzivatele a u kazdého pole znacky OK/BAD popr. popis chyby
dalsi chybyseznam chybejicich poli a dalsich chyb
funkce zkontroluje vstupni data podel daného schématu místo predávání prímo schématu (parametr typ formuláre) by mozná slo predávat data potrebná k jeho rozpoznání

Export:

Funkce Vstup Výstup Popis Poznámky
ExportDat
PopisPopis hledaných dat
Cílový formátformát dat, do kterého chceme data exportovat
sidsession id - pro kontrolu oprávnení
cildata v cílovém formátu
funkce vyexportuje vybraná data a prevede je do pozadovaného formátu dalsi varianta teto funkce by mela jeste jeden vstupni parametr a to jmeno souboru a data by ulozila do tohoto souboru. Ten by byl nasledne poskytnut ke stazeni. Problem by byl, kdy tento soubor smazat, aby si ho nestahl nekdo jiny nez si ho vyexportoval, kolize jmen, atp...

Import:

Funkce Vstup Výstup Popis Poznámky
ImportDat
DataData, která mají být importována
Formát datformát, ve kterém jsou importovaná data
sidsession id - pro kontrolu oprávnení
potvrzeniuspech nebo odmitnuti dat (spatný formát, není oprávnení, ...)
funkce naimportuje data do systému dalsi varianta teto funkce by mela jeste jeden vstupni parametr a to jmeno souboru a data by cetla z tohoto souboru.

Plánovac:

Funkce Vstup Výstup Popis Poznámky
VyberSchemaa
sidze sid se zjisti informace o uzivateli a ty se pouziji k vybrani formulare
datadata od uzivatele potrebna k vybrání správného formuláre (typicky pozadovaná akce a popripade druh zaznamu)
schemavraci schema odpovidajici vstupum, v pripade více schemat vrátí jejich seznam a jiz nechává na jiném modulu (formulárník) aby od uzivateli nabidl výber, popripade získal dalsi data k jednoznacnemu urceni schematu.
vybere schema formulare pro dana vstupni data
StavSberu
stavpozadovaný stav sberu, který se má nastavit
sidsession id pro kontrolu oprávnení
nastaví pozadovaný stav sberu, pricemz kontroluje, aby jednotlivé stavy následovaly správne po sobe
AccessControl
datapozadované omezení/povolení
operacejedna z operací nastavit, aktualizovat, smazat
sidsession id pro kontrolu oprávnení
funkce slouzi k nastavování vyjímek ze soucasného (podle stavu sberu) rízení prístupu uzivatelu
ProcesData
datadata, která mají být zarazena
typtyp dat (formát, pouzité schéma formulare)
sidsession id pro kontrolu oprávnení
uspech / odmitnutí (byl ukoncen sber, atp.) funkce slouzi k zarazení záznamu do sberu - kontroluje, zda muze být záznam zarazen vzhledem ke stavu sberu, ...
SetAutor
datainformace o autorovi
operacejedna z operací INSERT,UPDATE,DELETE
sidsession id pro kontrolu oprávnení
funkce slouzi k pridani/editaci autoru v systemu
GetAutor
popispopis hledaneho autora
sidsession id pro kontrolu oprávnení
seznamseznam odpovidajicich autoru, vcetne vsech moznych udaju o nich
funkce slouzi k hledání autoru a informaci o nich