|
Size: 2621
Comment:
|
← Revision 13 as of 2012-12-17 08:47:25 ⇥
Size: 1889
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Příkazy Distributora pro Golema = | = Příkazy Distributora pro Golema (Editace identifikátorů) = |
| Line 3: | Line 3: |
| Příkazy budou implementovány jako [[http://frnk.lightcomp.cz/docs/tahiti6/pg-dep2/content/ch04.html#frame0_remoteFcv|RemoteFunction]] (volání pomocí metody callFunction). Parametry a navratové hodnoty budou zakódovány ve formátu JSON. | Definice funkcí Golema, které slouží k editaci identifikátorů dokumentů. Příkazy budou implementovány jako [[http://frnk.lightcomp.cz/docs/tahiti6/pg-dep2/content/ch04.html#frame0_remoteFcv|RemoteFunction]] (volání pomocí metody callFunction). Parametry a návratové hodnoty budou zakódovány ve formátu JSON. Všechny metody mají stejnou signaturu |
| Line 7: | Line 11: |
| {} methodName(String,String,String,String,{}) | {} nazevmetody(DocumentAttributes) |
| Line 12: | Line 16: |
| Predavane parametry: | Příklad vstupnich parametrů: |
| Line 14: | Line 18: |
| { "id":"id_dokumentu", "version":"verze dokumentu", "serverVersion":"server version", "type":"dokutyp", "attributes":{"nazev_atributu":"hodnota_atributu"} |
DocumentAttributes { "id":"1234644", "version":"1", "serverVersion":"1", "type":"CEZ___SDGFTERfiobnsdhr___009-Dopis", "attributes":{"CJ":"1234567890","CPS_CPU":"134567698464"} |
| Line 23: | Line 27: |
| || Atribut || Význam || || id || id dokumentu || || version || verze dokumentu || || serverVersion || server version || || type || dokumentovy typ || || attributes || objekt s atributy dokumentu ( obsahuje pouze atributy z cmserver2.xml plus explicitně specifikované atributy příslušné akce, pokud existují )|| |
|
| Line 24: | Line 36: |
| Navratovy kod | Navratova hodnota |
| Line 27: | Line 39: |
| "status":"OK|FAIL", "errorMessage":"Popis chyby" "errorDetail":"Detail chyby" } }}} == Golem.changeDocType == Funkce getActiveUsers vrátí seznam všech připojených uživatelů. Návratovou hodnotou je pole jednotlivých uživatelů. {{{ Method signature [] Distributor.getActiveUsers() }}} {{{ Objekt reprezentující jednoho uživatele { "user":string, "client":string, "version"":string, "ip":string, "start":string |
"status":"OK", "errorMessage":"" "errorDetail":"" |
| Line 62: | Line 47: |
| || user || uživatelské jméno || || client || název klientské aplikace (viz. [[http://frnk.lightcomp.cz/docs/tahiti6/pg-dep2/content/ch04.html#frame0_hello|Hello]] v protokolu)|| || version || verze klientské aplikace (viz. [[http://frnk.lightcomp.cz/docs/tahiti6/pg-dep2/content/ch04.html#frame0_hello|Hello]] v protokolu)|| || ip || ip adresa odkud je uživatel připojen || || start || čas, kdy se uživatel připojil YYYYMMDDHHmmss|| == Golem.changeArea == Funkce getUserState vrátí informace jestli je uživatel připojen. Parametrem metody je uživatelske jméno. Návratovou hodnotou je objekt popisující atributy připojení. Pokud uživatel není připojen nebo neexistuje vrací se prázdný objekt. {{{ Method signature {} Distributor.getUserState(string) }}} |
|| status || Návratový kód, možné hodnoty OK,FAIL || || errorMessage || chybová hláška || || errorDetail || detailní popis chyby || |
| Line 79: | Line 52: |
| {{{ Objekt s atributy připojení { "client":string, "version"":string, "ip":string, "start":string } }}} || Atribut || Význam || || client || název klientské aplikace (viz. [[http://frnk.lightcomp.cz/docs/tahiti6/pg-dep2/content/ch04.html#frame0_hello|Hello]] v protokolu)|| || version || verze klientské aplikace (viz. [[http://frnk.lightcomp.cz/docs/tahiti6/pg-dep2/content/ch04.html#frame0_hello|Hello]] v protokolu)|| || ip || ip adresa odkud je uživatel připojen || || start || čas, kdy se uživatel připojil YYYYMMDDHHmmss|| == Golem.changeEntity == |
|
| Line 100: | Line 53: |
| Změna některého atributu nebo atributů dokumentu. Pokrývá požadavky na změnu dokutypu, oblasti a atributů. | |
| Line 102: | Line 56: |
| Vytvoření kopie dokumentu. CPS_CPU obsahuje číslo cílové entity, ke které má kopie patřit | |
| Line 103: | Line 58: |
| == Golem.invalidateDocument == == Golem.unidentifyDocument == |
== Golem.changeDocumentState == Zneplatnění nebo přesun mezi neidentifikované dokumenty. Atribut Document.newState obsahuje hodnotu INVALID nebo UNIDENTIFIED. INVALID - přesun dokumenty mezi zneplatněné, UNIDENTIFIED - přesun dokumentu mezi neidentifikované |
Příkazy Distributora pro Golema (Editace identifikátorů)
Definice funkcí Golema, které slouží k editaci identifikátorů dokumentů.
Příkazy budou implementovány jako RemoteFunction (volání pomocí metody callFunction). Parametry a návratové hodnoty budou zakódovány ve formátu JSON.
Všechny metody mají stejnou signaturu
Signatura metody
{} nazevmetody(DocumentAttributes)Příklad vstupnich parametrů:
DocumentAttributes {
"id":"1234644",
"version":"1",
"serverVersion":"1",
"type":"CEZ___SDGFTERfiobnsdhr___009-Dopis",
"attributes":{"CJ":"1234567890","CPS_CPU":"134567698464"}
}Atribut |
Význam |
id |
id dokumentu |
version |
verze dokumentu |
serverVersion |
server version |
type |
dokumentovy typ |
attributes |
objekt s atributy dokumentu ( obsahuje pouze atributy z cmserver2.xml plus explicitně specifikované atributy příslušné akce, pokud existují ) |
Navratova hodnota
{
"status":"OK",
"errorMessage":""
"errorDetail":""
}Atribut |
Význam |
status |
Návratový kód, možné hodnoty OK,FAIL |
errorMessage |
chybová hláška |
errorDetail |
detailní popis chyby |
Golem.changeAttributes
Změna některého atributu nebo atributů dokumentu. Pokrývá požadavky na změnu dokutypu, oblasti a atributů.
Golem.copyDocument
Vytvoření kopie dokumentu. CPS_CPU obsahuje číslo cílové entity, ke které má kopie patřit
Golem.changeDocumentState
Zneplatnění nebo přesun mezi neidentifikované dokumenty. Atribut Document.newState obsahuje hodnotu INVALID nebo UNIDENTIFIED. INVALID - přesun dokumenty mezi zneplatněné, UNIDENTIFIED - přesun dokumentu mezi neidentifikované