Differences between revisions 2 and 7 (spanning 5 versions)
Revision 2 as of 2012-10-17 08:51:08
Size: 2542
Editor: KarelZacek
Comment:
Revision 7 as of 2012-10-17 09:20:24
Size: 1352
Editor: KarelZacek
Comment:
Deletions are marked like this. Additions are marked like this.
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. 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

{{{
Signatura metody
 {} nazevmetody(String,String,String,String,{})
}}}
Line 7: Line 14:
Predavane parametry: Příklad vstupnich parametrů:

[
"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
Line 10: Line 37:
"id":"id_dokumentu",
"version":"verze dokumentu",
"serverVersion":"server version",
"type":"dokutyp",
"attributes":{"nazev_atributu":"hodnota_atributu"}
}
}}}

{{{
Navratovy kod

{
"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 57: Line 45:
|| 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||
|| status || Návratový kód, možné hodnoty OK,FAIL ||
|| errorMessage || chybová hláška ||
|| errorDetail || detailní popis chyby ||
Line 63: Line 49:
== 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)
}}}


{{{
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 ==

Příkazy Distributora pro Golema

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(String,String,String,String,{})

Příklad vstupnich parametrů:

[
"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

Golem.copyDocument

Golem.invalidateDocument

Golem.unidentifyDocument

DistributorCommandsGolem (last edited 2012-12-17 08:47:25 by pyta)