com.stellent.cis.client.api.sis.user
Interface ISISUserAPI

All Superinterfaces:

ICommandAPI

public interface ISISUserAPI
extends ICommandAPI

The command API implementation of the user commands. This implementation can be accessed directly via the ICommandFacade class, using the API name user, with the following syntax:

 ISISUserAPI commandAPI =
       (ISISUserAPI)m_commandFacade.getCommandAPI ("user", m_commandFacade.getCommandTypeForName ("fixed"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

java.lang.String	login(java.lang.String adapterName, java.lang.String userName, java.lang.String password) Logs a user into the fixed system.
java.lang.String	login(java.lang.String adapterName, java.lang.String userName, java.lang.String password, java.lang.String licenseView, java.lang.String style) Logs a user into the fixed system.
java.lang.String	loginAlias(java.lang.String adapterName, java.lang.String userAlias, java.lang.String userAliasKey, java.lang.String licenseView, java.lang.String style) Allows the Web SDK user to log a user into the Acorde Context system using an alias.
java.lang.String	loginProcess(java.lang.String adapterName, java.lang.String userName, java.lang.String password, java.lang.String processDatabaseName, java.lang.String licenseView, java.lang.String style) Logs a user into the fixed system and the fixed process system.
java.lang.String	loginProcessAlias(java.lang.String adapterName, java.lang.String userAlias, java.lang.String userAliasKey, java.lang.String processDatabaseName, java.lang.String licenseView, java.lang.String style) Allows the fixed SDK user to log in to the Acorde Process system using an alias.
void	logout(ISISContext SISContext) Allows the user to logout to reclaim a license.
java.lang.String	registerAlias(java.lang.String adapterName, java.lang.String alias, java.lang.String userName, java.lang.String password) Allows the user to register an alias for a username/password combination.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

loginAlias

java.lang.String loginAlias(java.lang.String adapterName,
                            java.lang.String userAlias,
                            java.lang.String userAliasKey,
                            java.lang.String licenseView,
                            java.lang.String style)
                            throws CommandException

Allows the Web SDK user to log a user into the Acorde Context system using an alias. The alias must have been previously registered using the User.registerAlias call described below. Allows a Web SDK user to get an xmlAIID for use in future functional calls.

Parameters:

adapterName - The adapter name to log in to.

userAlias - The user alias to login as.

userAliasKey - The user alias key to log in with.

licenseView - The name of the license type you want to use when logging in as a string. This value can be "WebView" or "FullSeat".

style - Reserved for future use.

Throws:

CommandException

login

java.lang.String login(java.lang.String adapterName,
                       java.lang.String userName,
                       java.lang.String password)
                       throws CommandException

Logs a user into the fixed system. If successful further calls on the fixed system using the context object will be treated as authenticated.

Parameters:

adapterName - The adapter name to log in to.

userName - The user name to log in with.

password - The password to log in with.

Throws:

CommandException

login

java.lang.String login(java.lang.String adapterName,
                       java.lang.String userName,
                       java.lang.String password,
                       java.lang.String licenseView,
                       java.lang.String style)
                       throws CommandException

Logs a user into the fixed system. If successful further calls on the fixed system using the context object will be treated as authenticated.

Parameters:

adapterName - The adapter name to log in to.

userName - The user name to log in with.

password - The password to log in with.

licenseView - The name of the license type you want to use when logging in as a string. This value can be "WebView" or "FullSeat".

style - Reserved for future use.

Throws:

CommandException

loginProcessAlias

java.lang.String loginProcessAlias(java.lang.String adapterName,
                                   java.lang.String userAlias,
                                   java.lang.String userAliasKey,
                                   java.lang.String processDatabaseName,
                                   java.lang.String licenseView,
                                   java.lang.String style)
                                   throws CommandException

Allows the fixed SDK user to log in to the Acorde Process system using an alias. The alias must have been previously registered using the User.registerAlias. Allows a fixed SDK user to get an xmlAIID for use in future functional calls.

Parameters:

adapterName - The adapter name to log in to.

userAlias - The user alias to login as.

userAliasKey - The user alias key to log in with.

processDatabaseName - The name of the Acorde Process database you want to connect to.If an empty string is provided, the call will connect to the first Acorde Process Database it finds in the Process Database List.

licenseView - The name of the license type you want to use when logging in as a string. This value can be "WebView" or "FullSeat".

style - Reserved for future use.

Throws:

CommandException

loginProcess

java.lang.String loginProcess(java.lang.String adapterName,
                              java.lang.String userName,
                              java.lang.String password,
                              java.lang.String processDatabaseName,
                              java.lang.String licenseView,
                              java.lang.String style)
                              throws CommandException

Logs a user into the fixed system and the fixed process system. If successful further calls on the fixed system using the context object will be treated as authenticated.

Parameters:

adapterName - The adapter name to log in to.

userName - The user name to log in with.

password - The password to log in with.

processDatabaseName - The name of the Acorde Process database you want to connect to.If an empty string is provided, the call will connect to the first Acorde Process Database it finds in the Process Database List.

licenseView - The name of the license type you want to use when logging in as a string. This value can be "WebView" or "FullSeat".

style - Reserved for future use.

Throws:

CommandException

logout

void logout(ISISContext SISContext)
            throws CommandException

Allows the user to logout to reclaim a license.

Parameters:

SISContext - the context object representing the current user

Throws:

CommandException

registerAlias

java.lang.String registerAlias(java.lang.String adapterName,
                               java.lang.String alias,
                               java.lang.String userName,
                               java.lang.String password)
                               throws CommandException

Allows the user to register an alias for a username/password combination. Allows a user to get an xmlAIIK for use in future functional calls.

Parameters:

adapterName - The adapter name to log in to.

alias - The alias to register.

userName - The user name to associate with alias.

password - The password for specififed user name.

Throws:

CommandException