com.ssaglobal.bde
Class BdeToolkit

java.lang.Object
  |
  +--com.ssaglobal.bde.BdeToolkit

public abstract class BdeToolkit

extends java.lang.Object

BdeToolkit is a helper class for creating various objects required for the formation and execution of a request. A default toolkit can be retrieved by calling the getDefaultToolkit() method.

Method Summary

abstract IBdeFilter	createBdeFilter() Creates an IBdeFilter object.
abstract IBdeSelection	createBdeSelection() Creates an IBdeSelection object.
abstract IPublishControl	createPublishControl(java.lang.String eventConsumer) Creates an IPublishControl object.
abstract IUserSession	createUserSession() Creates an IUserSession object.
abstract IUserSession	createUserSession(java.lang.String sUser, java.lang.String sPassword) Creates an IUserSession object for a given username/password.
static BdeToolkit	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 BdeToolkit getDefaultToolkit()
                                    throws java.lang.RuntimeException

Retrieves the default implementation.

Returns:

the default implementation of this abstract class

Throws:

java.lang.RuntimeException - if the installation is faulty

createUserSession

public abstract IUserSession createUserSession()

Creates an IUserSession object. This constructor for UserSession can be used when a specific Username is not relevant.

Returns:

a new user session object (shall not be null)

createUserSession

public abstract IUserSession createUserSession(java.lang.String sUser,
                                               java.lang.String sPassword)

Creates an IUserSession object for a given username/password.

Returns:

a new user session object (shall not be null)

createBdeFilter

public abstract IBdeFilter createBdeFilter()

Creates an IBdeFilter object. This object is used to create Filters on a BDE. A filter helps select specific records from the server and can be compared to a 'where clause' in a SQL statement.

A Filter object can be applied to the Show and List methods.

Returns:

IBdeFilter a Filter object.

createBdeSelection

public abstract IBdeSelection createBdeSelection()

Creates an IBdeSelection object. This object is used to define which attributes should be retrieved from the server and can be compared to the 'select table.field' of a SQL statement.

A Selection object can be applied to the Show and List methods.

Returns:

IBdeSelection a Filter object.

createPublishControl

public abstract IPublishControl createPublishControl(java.lang.String eventConsumer)

Creates an IPublishControl object. This object can be used in case the BDE supports Events.

Parameters:

eventConsumer - This is the name/id of the user/application that requests a asynchronous List.

Returns:

IPublishControl object.