com.ibm.workflow.api
Interface Service

All Known Subinterfaces:
ExecutionService

public interface Service


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

isLoggedOn

public boolean isLoggedOn()
                   throws FmcException
Indicates whether a user logged on via this service object. This API call tells you the logon status known by the client. When issuing an action call, the session may, however, be not found because it expired or because you reconstructed a session from a different system group.

Throws:
FmcException - thrown if an API error or a communication error occurred.

reconnectCount

public int reconnectCount()
                   throws FmcException
Returns the number of times the client tries to reconnect to a server in cases where the client connection is lost.

Throws:
FmcException - thrown if an API error or a communication error occurred.

systemName

public java.lang.String systemName()
                            throws FmcException
Returns the name of the system where the server resides.

Throws:
FmcException - thrown if an API error or a communication error occurred.

systemGroupName

public java.lang.String systemGroupName()
                                 throws FmcException
Returns the name of the system group where the server resides.

Throws:
FmcException - thrown if an API error or a communication error occurred.

timeout

public int timeout()
            throws FmcException
Returns the time the client will wait for a server to answer.

Throws:
FmcException - thrown if an API error or a communication error occurred.

userID

public java.lang.String userID()
                        throws FmcException
Returns the user identification of the logged-on user.

Throws:
FmcException - thrown if an API error or a communication error occurred.

refresh

public void refresh()
             throws FmcException

This API call refreshes the logon status from the server (action call).

Throws:
FmcException - thrown if an API error or a communication error occurred.

setReconnectCount

public void setReconnectCount(int count)
                       throws FmcException
Sets the number of times

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.

Throws:
FmcException - thrown if an API error or a communication error occurred.

setPassword

public void setPassword(java.lang.String newPassword)
                 throws FmcException

This API call allows a user's password to be changed (action call).

Note:
The password is case-sensitive.

The following rules apply for specifying a password:

Throws:
FmcException - thrown if an API error or a communication error occurred.

setTimeout

public void setTimeout(int timeout)
                throws FmcException
Sets the time

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.

Throws:
FmcException - thrown if an API error or a communication error occurred.

userSettings

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.

Throws:
FmcException - thrown if an API error or a communication error occurred.


© Copyright IBM Corporation 1999, 2008. All Rights Reserved.