com.businessobjects.dsws
Class Consumer

java.lang.Object
  com.businessobjects.dsws.Consumer

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BICatalog, BIPlatform, Publish, QueryService, ReportEngine, SaveService, Session

public abstract class Consumer
extends java.lang.Object
implements java.io.Serializable

The Consumer class is the abstract base class of all helpers. It contains most of the information to consume Business Objects web services.

See Also:

Serialized Form

Constructor Summary

Consumer()

Method Summary

static java.lang.String	displayException(AxisFault objDswsException) Get the string to display the exception
static DSWSException	GetAxisFaultDetails(AxisFault axisFault)
Connection	getConnection() Gets the Connection object associated with this Consumer.
Connection	getConnection(java.lang.String strURL) Returns a new Connection object which is a copy of the one used by this Consumer.
ConnectionState	getConnectionState() Returns a new ConnectionState object which is a copy of the one used by this Consumer.
Consumer	getConsumer(java.lang.String strWSType, java.lang.String strWSUrl) Gets a Consumer object given the Web Service type and Web Service URL.
Consumer	getConsumer(java.lang.String strWebServiceMethod, java.lang.String strWSType, java.lang.String strWSUrl) Internal Use Only.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Consumer

public Consumer()

Method Detail

getConsumer

public Consumer getConsumer(java.lang.String strWSType,
                            java.lang.String strWSUrl)
                     throws AxisFault

Gets a Consumer object given the Web Service type and Web Service URL.

Parameters:

strWSType - the Web Service type as a String such as Session, BICatalog, ReportEngine, QueryService, Publish...

strWSUrl - the Web Service URL as a String

Returns:

a Consumer object given the Web Service type and Web Service URL, that is an instance of Session, BICatalog, ReportEngine, QueryService, Publish...

Throws:

AxisFault

getConsumer

public Consumer getConsumer(java.lang.String strWebServiceMethod,
                            java.lang.String strWSType,
                            java.lang.String strWSUrl)
                     throws AxisFault

Internal Use Only.

Throws:

AxisFault

getConnection

public Connection getConnection()
                         throws AxisFault

Gets the Connection object associated with this Consumer.

Returns:

the Connection object associated with this Consumer

Throws:

AxisFault

getConnection

public Connection getConnection(java.lang.String strURL)
                         throws AxisFault

Returns a new Connection object which is a copy of the one used by this Consumer.
Note:If you change a value in the Connection returned, it will not affect the given Consumer Connection.

Returns:

the Connection object associated with this Consumer

Throws:

AxisFault

getConnectionState

public ConnectionState getConnectionState()

Returns a new ConnectionState object which is a copy of the one used by this Consumer.
Note:If you change a value in the ConnectionState returned, it will not affect the given Consumer ConnectionState.

Returns:

the ConnectionState object associated with this Consumer

displayException

public static java.lang.String displayException(AxisFault objDswsException)

Get the string to display the exception

Parameters:

None -

Returns:

String the display string

Throws:

None

GetAxisFaultDetails

public static DSWSException GetAxisFaultDetails(AxisFault axisFault)