Differences between revisions 1 and 8 (spanning 7 versions)
Revision 1 as of 2012-10-17 08:30:26
Size: 2214
Editor: KarelZacek
Comment:
Revision 8 as of 2012-10-17 10:05:44
Size: 1469
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. 
Line 5: Line 5:
== Golem.changeDocType ==

Funkce getActiveUsers vrátí seznam všech připojených uživatelů. Návratovou hodnotou je pole jednotlivých uživatelů.
Všechny metody mají stejnou signaturu
Line 10: Line 8:
Method signature

 [] Distributor.getActiveUsers()
Signatura metody
 {} nazevmetody(String,String,String,String,{})
Line 15: Line 12:
Line 16: Line 14:
Objekt reprezentující jednoho uživatele 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 19: Line 37:
"user":string,
"client":string,
"version"":string,
"ip":string,
"start":string
"status":"OK",
"errorMessage":""
"errorDetail":""
Line 29: 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||

== 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 46: Line 50:
{{{
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 67: Line 51:
Změna některého atributu nebo atributů dokumentu. Pokrývá požadavky na změnu dokutypu, oblasti a atributů.

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

Změna některého atributu nebo atributů dokumentu. Pokrývá požadavky na změnu dokutypu, oblasti a atributů.

Golem.copyDocument

Golem.invalidateDocument

Golem.unidentifyDocument

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