Marbes Consulting s.r.o.
EOS4
Podmínky omezující zveřejnění
Autorem tohoto dokumentu je společnost MARBES CONSULTING s.r.o. Dokument obsahuje informace důvěrného charakteru a ve smyslu definice autorského práva (viz § 2, odst. 1 Zákona č. 121/2000 Sb., zákon o právu autorském) je duševním vlastnictvím autora a předmětem práva autorského. Dokument smí být použit výhradně za účelem, za kterým byl poskytnut a nesmí být bez předchozího souhlasu autora citován, kopírován, vytěžován1 nebo předán třetí fyzické či právnické osobě.
© 2009 MARBES CONSULTING s.r.o.
1 Vytěžováním se podle zákona č. 121/2000 Sb. rozumí trvalý nebo dočasný přepis celého obsahu nebo jeho podstatné části na jiný podklad, a to jakýmikoli prostředky nebo jakýmkoli způsobem.
Pokud metoda vrací seznam objektů, může být výsledný vracený seznam stránkovaný. Informaci o stránkování obsahuje atribut paging, ve kterém se nachází i informace, zda server uchovává další data (existuje další stránka). Vychozí velikost jedné stránky je 500 záznamů. Objekt paging obsahuje identifikátor seznamu dat (lid) a ten je nutné předat do metody, která načte další stránku (typický název metody je getNextXxx).
Při načítání stránkovaného seznamu nemusí vždy odpovídat počet vrácených záznamů parametru totalCount, který je uveden v objektu paging. Toto se projeví pouze v případě, že jsou během stránkovaného načítání některé vracené objekty z EOS odstraněny.
Některé metody podporují filtrování dat, např. načtení seznamu aplikací. Filtr se předává formou řetězce, ve kterém je zapsána podmínka. Podmínku lze použít POUZE na základní atributy vracených objektů. Podmínku nelze tedy použít na další vnořené hodnoty, např. kontakty osoby. Pro tento účel existují samostatné metody.
Podmínky u filtrů je možné sestavovat pouze stylem ATRIBUT OPERÁTOR HODNOTA, nelze tedy např. porovnávat dva atributy
navzájem. Řetězcová hodnota se VŽDY uvádí v apostrofech (jinak bude chybně chápána jako název atributu a bude vyhozena
chyba), pokud hodnota obsahuje apostrof, musí být znak zapsán jako dva apostrofy ''. U operátorů like a ilike je možné
použít znak %, který nahrazuje žádný nebo libovolný počet znaků. Znak % lze používat pouze na začátku
a konci hodnoty. Pokud je potřeba zapsat hodnotu null, je zapsána bez uvozovek. Datum je nutné zapsat ve formátu:
dd.MM.yyyy HH:mm:ss.SSS
nebo zkráceně bez času dd.MM.yyyy
. Pro boolean hodnoty se uvádí
hodnota 'true' nebo 1 pro true a 'false' nebo 0 pro false, textové reprezentace musí být uvedeny v apostrofech.
Podmínky jsou omezeny na počet porovnávaných hodnot. U výrazu jmeno = 'petr' and id in ('1', '2', '3')
je počet podmínek 4. Maximální bezpečný počet je 1000, ale EOS toto nijak nekontroluje. Při použití vyššího počtu může,
ale nemusí dotaz projít. Toto je z důvodu, že EOS do některých dotazů přidává vlastní podmínky a tudíž se může stát,
že bude překročen limit DB serveru na velikost podmínky.
Příklad zapsání filtru na osoby, jejichž uživatelské jméno je "kolomaznik" a titul začíná na 'i':
username = "kolomaznik" and degreeBefore ilike 'i%'
Název | Popis |
---|---|
assignEnvironment | Přiřazení prostředí k aplikaci. |
detachEnvironment | Odebrání prostředí od aplikace. |
findEnvironmentsByFilter | Hledání prostředí podle předaného filtru. |
findEnvironmentsByIds | Hledání prostředí podle předaného seznamu id. |
getNextEnvironments | Načtení další části stránkovaného seznamu prostředí. |
isApplicationAssignToEnvironment | Metoda zjistí, jestli je aplikace zařazena do prostředí. |
syncEnvironment | Provede synchronizaci prostředí. |
Název | Popis |
---|---|
EosEnvironment | Prostředí. |
EosEnvironments | Seznam prostředí. |
EosPaging | Objekt obsahující informace pro stránkování vrácených záznamů prostředí. |
EosProfileIds | Objekt obsahující seznam id prostředí. |
Prostředí nemusí být aplikaci přiřazno, pokud se již v prostředí nachází aplikace se stejným kódem. V takovém případě vrátí metoda vyjímku.
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
environmentId | String | Ano | id prostředí |
applicationId | String | Ano | id aplikace |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
environmentId | String | Ano | id prostředí |
applicationId | String | Ano | id aplikace |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
filter | String | Ne | filtr na prostředí |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
environmentIds | EosProfileIds | Ano | seznam id prostředí |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
lid | String | Ano | list id |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
environmentId | String | Ano | id prostředí |
applicationId | String | Ano | id aplikce |
Pokud v objektu není předán identifikátor, tak bude vytvořeno nové prostředí. V opačném případě dojde k aktualizaci údajů na existujícím prostředí. Jestliže je identifikátor vyplněn, ale existující prostředí nebude nalezeno, bude vyvolána vyjímka WSObjectNotFoundException.
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
environment | EosEnvironment | Ano | prostředí které bude aktualizováno, nebo vytvořeno |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
id | String | Ne | Id prostředí. |
name | String | Ne | Název prostředí. |
description | String | Ne | Popis prostředí. |
code | String | Ne | Kód prostředí. |
testing | Boolean | Ne | Příznak jestli je prostředí testovací, nebo produktivní. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
environments | List<EosEnvironment> | Ne | Seznam prostředí. |
paging | EosPaging | Ne | Stránkování. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
lid | String | Ne | List id nebo null, pokud stránkování není vyžadováno. |
start | int | Ne | Index prvního záznamu, který byl aktuálně vrácen. |
totalCount | int | Ne | Celkový počáteční záznamů. |
hasNext | boolean | Ne | Příznak, zda jsou k dispozici ještě další záznamy. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
environmentIds | List<String> | Ne | Seznam id prostředí. |