Java Client API Reference 6.0.2.61

com.baan.b3.boi1
Class BoiToolkit

java.lang.Object
  |
  +--com.baan.b3.boi1.BoiToolkit

public abstract class BoiToolkit
extends java.lang.Object

Ties the interfaces to an implementation.
An implementation for the ISynchronization and IUserInfo interfaces can be created using a subclass of this class. Subclasses of this class should be singletons. The default implementation can be retrieved using the getDefaultToolkit() method

Version:
Build Nr 61, file version \\main\\4, 15:08:54 24-07-2006 UTC

Method Summary
abstract  IBackend createBackend(java.lang.String p_BusComponentID)
          Creates an IBackend object.
abstract  ISynchronization createSynchronization()
          Creates an ISynchronization object.
abstract  IUserInfo createUserInfo()
          Creates an IUserInfo object.
abstract  IUserSession createUserSession()
          Creates an IUserSession object.
abstract  IUserSession createUserSession(IUserInfo ui)
          Creates an IUserSession object with some userinfo.
static BoiToolkit getDefaultToolkit()
          Retrieves the default implementation.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDefaultToolkit

public static BoiToolkit getDefaultToolkit()
                                    throws java.lang.RuntimeException
Retrieves the default implementation.
Threading policy: MTSafe
Returns:
the default implementation of this abstract class
Throws:
java.lang.RuntimeException - if the installation is faulty

createSynchronization

public abstract ISynchronization createSynchronization()
                                                throws BoiException
Creates an ISynchronization object.
Threading policy: MTSafe
Returns:
a new ISynchronization object (shall not be null)
Throws:
BoiException - if something went wrong in the creation process

createUserInfo

public abstract IUserInfo createUserInfo()
Creates an IUserInfo object.
Threading policy: MTSafe
Returns:
a new user information object (shall not be null)

createUserSession

public abstract IUserSession createUserSession(IUserInfo ui)
Creates an IUserSession object with some userinfo.
Threading policy: MTSafe
Parameters:
ui - IUserInfo object containing the information about the user
Returns:
a new user session object (shall not be null)

createUserSession

public abstract IUserSession createUserSession()
Creates an IUserSession object. This constructor for UserSession can be used when the Username is not relevant. f.e. When License - Override is used withous activation.
Threading policy: MTSafe
Returns:
a new user session object (shall not be null)

createBackend

public abstract IBackend createBackend(java.lang.String p_BusComponentID)
Creates an IBackend object. This Object represents the backend and can be used to do various control actions
Threading policy: MTSafe
Parameters:
p_BusComponentID - BusComponent Identifier Identifying the OpenWorld Backend.
Returns:
a new Backend object (shall not be null)

Java Client API Reference 6.0.2.61

Visit the SSA Global website for more information.