|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
---|---|
boolean |
isLoggedOn()
Indicates whether a user logged on via this service object. |
int |
reconnectCount()
Returns the number of times the client tries to reconnect to a server in cases where the client connection is lost. |
void |
refresh()
This API call refreshes the logon status from the server (action call). |
void |
setPassword(java.lang.String newPassword)
This API call allows a user's password to be changed (action call). |
void |
setReconnectCount(int count)
Sets the number of times |
void |
setTimeout(int timeout)
Sets the time |
java.lang.String |
systemGroupName()
Returns the name of the system group where the server resides. |
java.lang.String |
systemName()
Returns the name of the system where the server resides. |
int |
timeout()
Returns the time the client will wait for a server to answer. |
java.lang.String |
userID()
Returns the user identification of the logged-on user. |
Person |
userSettings()
This API call returns all settings of the logged on user (action call). |
Method Detail |
public boolean isLoggedOn() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public int reconnectCount() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String systemName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String systemGroupName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public int timeout() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String userID() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public void refresh() throws FmcException
This API call refreshes the logon status from the server (action call).
FmcException
- thrown if an API error or a communication error occurred.public void setReconnectCount(int count) throws FmcException
the client tries to reconnect to a server in cases where the client connection is lost. The default is taken from the ReconnectCount value in the configuration; if not specified there, the default is 3 times.
FmcException
- thrown if an API error or a communication error occurred.public void setPassword(java.lang.String newPassword) throws FmcException
This API call allows a user's password to be changed (action call).
The following rules apply for specifying a password:
FmcException
- thrown if an API error or a communication error occurred.public void setTimeout(int timeout) throws FmcException
the client will wait for a server to answer. The time is to be specified in milliseconds. The default is taken from the APITimeOut value in the configuration; if not specified there, the default is 180000 milliseconds.
FmcException
- thrown if an API error or a communication error occurred.public Person userSettings() throws FmcException
This API call returns all settings of the logged on user (action call).
An empty object respectivly a null pointer is returned if no user has logged on yet via this service object.
FmcException
- thrown if an API error or a communication error occurred.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |