All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.workflow.api.Service
- public interface Service
- Version:
- 3.2.0.2
-
isLoggedOn()
- Indicates whether a user is logged
on via this service object.
-
refresh()
-
This function/method refreshes the log on status from the server(action
call).
-
setPassword(String)
-
This function/method allows a user's password to be changed (action
call).
-
setTimeout(int)
- Sets the time the client will wait
for a server to answer.
-
systemGroupName()
- Returns the name of the
system group where the server resides.
-
systemName()
- Returns the name of the system
where the server resides.
-
timeout()
- Returns the time the client will wait
for a server to answer.
-
userID()
- Returns the user identification of the
logged-on user.
-
userSettings()
-
This function/method returns all settings of the logged on user (action
call).
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.
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.
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.
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.
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.
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.
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:
- You can specify a maximum of 32 characters.
- You can use any printable characters depending on your current
locale.
- Do not use DBCS characters.
Note: | If you intend to work in a multi-platform environment or switch between
codepages, it is recommended that you use alphabetic characters, digits, and
blanks only. This is because it cannot be guaranteed that special
characters are available in all codepages.
|
- Throws: FmcException
- thrown if an API error or a communication error occurred.
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.
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