All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.Service

public interface Service
Version:
3.2.0.2

Method Index

 o isLoggedOn()
Indicates whether a user is logged on via this service object.
 o refresh()

This function/method refreshes the log on status from the server(action call).

 o setPassword(String)

This function/method allows a user's password to be changed (action call).

 o setTimeout(int)
Sets the time the client will wait for a server to answer.
 o systemGroupName()
Returns the name of the system group where the server resides.
 o systemName()
Returns the name of the system where the server resides.
 o timeout()
Returns the time the client will wait for a server to answer.
 o userID()
Returns the user identification of the logged-on user.
 o userSettings()

This function/method returns all settings of the logged on user (action call).

Methods

 o isLoggedOn
 public abstract boolean isLoggedOn() throws FmcException
Indicates whether a user is logged on via this service object.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o systemName
 public abstract 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.
 o systemGroupName
 public abstract 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.
 o timeout
 public abstract 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.
 o userID
 public abstract 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.
 o refresh
 public abstract void refresh() throws FmcException

This function/method refreshes the log on status from the server(action call).

Throws: FmcException
thrown if an API error or a communication error occurred.
 o setPassword
 public abstract void setPassword(String newPassword) throws FmcException

This function/method 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.
 o setTimeout
 public abstract void setTimeout(int timeout) throws FmcException
Sets the time the client will wait for a server to answer.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o userSettings
 public abstract Person userSettings() throws FmcException

This function/method 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.

All Packages  Class Hierarchy  This Package  Previous  Next  Index