de.innovationgate.wgaservices

Interface WGAServices

All Known Subinterfaces:

WGACoreServices, WGACustomServices

public interface WGAServices

super interface for all WGAServices

Method Summary

Methods

Modifier and Type	Method and Description
ActionResult	callAction(RemoteSession session, String dbKey, String actionID, String executionContext, List<Object> params, Form form) Calls a remote action on the WGA server.
int	getAccessLevel(RemoteSession session, String dbKey) Returns the access level of the current session for a given database
RemoteSession	login(String domain, String user, String pwd) Logs in to the WGA server and returns an object that represents a remote database session.

Method Detail

login

RemoteSession login(String domain,
                  String user,
                  String pwd)
                    throws WGAServiceException

Logs in to the WGA server and returns an object that represents a remote database session.

Parameters:

domain - The WGA domain to log in to

user - The login user

pwd - The login password

Returns:

A remote session object if the login succeeds

Throws:

WGAServiceException

callAction

ActionResult callAction(RemoteSession session,
                      String dbKey,
                      String actionID,
                      String executionContext,
                      List<Object> params,
                      Form form)
                        throws WGAServiceException

Calls a remote action on the WGA server. Since this method call is quite complex because of its numerous parameters it is often more comfortable to use an ActionCaller instead.

Parameters:

session - The session to use

dbKey - Key of the database that contains the session

actionID - ID of the action to call

executionContext - Context expression specifying the execution context of the action

params - Action parameters. First element in the list becomes tmlparam1 and so on.

form - TMLForm object to post with the action.

Returns:

Return value of the action

Throws:

WGAServiceException

getAccessLevel

int getAccessLevel(RemoteSession session,
                 String dbKey)
                   throws WGAServiceException

Returns the access level of the current session for a given database

Parameters:

session - The session to use

dbKey - The database

Returns:

A constant of WGDatabase.ACCESSLEVEL_.... (from the WGAPI)

Throws:

WGAServiceException