com.ssaglobal.bdeimpl.java
Class BdeManager

java.lang.Object
  |
  +--com.ssaglobal.bdeimpl.java.BdeManager

public abstract class BdeManager

extends java.lang.Object

Superclass for the generated TypeSafe Bde Manager Proxies, All methods available in this class are also available on the Generated Bde Manager.

Field Summary

int	PROCESSING_SCOPE_BDE Processing scope BDE, indicating processing scope BDE
int	PROCESSING_SCOPE_BDE_COMPONENT Processing scope Component, indicating processing scope Component
int	PROCESSING_SCOPE_NOT_APPLICABLE Processing scope Not Applicable, indicating processing scope Not Applicable
int	PROCESSING_SCOPE_REQUEST Processing scope Request, indicating processing scope Request

Constructor Summary

BdeManager()

Method Summary

void	automaticReferences(boolean pAutomaticReference) Enables the automatic creation of References (Locks) by the backend, for example in case of a Show.
void	clearInformation() Removes all existing non-fatal errors or warnings from this manager.
void	close() Closes this Manager and removes reference to Transport and Activation
void	createReference(BusinessDataEntity pBde) Create a Backend reference (lock) for an individual BDE, and it's sub BDEs
void	deleteReference(BusinessDataEntity pBde) Delete and remove an backend BDE Reference (lock)
IBdeMessageIterator	getInformation() Returns the information (warnings and non fatal errors) from this manager
int	getIteratorFetchSize() Returns the Iterator fetch Size
long	getTimeOut() Returns the timeout
boolean	hasInformation() Check this Manager for Warnigs and non-fatal errors
void	initialize(java.lang.String backendComponentName) Initialize the manager.
void	ping() Try to ping the backend, for testing communication and transports
void	setFilter(IBdeFilter p_filter)
void	setIteratorFetchSize(int iteratorSize) Sets the Iterator fetch Size
void	setProcessingScope(int pProcessingScope)
void	setSelection(IBdeSelection p_selection)
void	setTimeOut(long milliseconds) Set the maximum time the client waits for an repy and before throwing an Communication exception
boolean	supportsProcessingScope(int pProcessingScope) Check if backend supports a certain processing Scope
boolean	supportsReferentialIntegrity() Checks if the backend support the Referential Integrity features

Methods inherited from class java.lang.Object

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

Field Detail

PROCESSING_SCOPE_REQUEST

public int PROCESSING_SCOPE_REQUEST

Processing scope Request, indicating processing scope Request

PROCESSING_SCOPE_BDE

public int PROCESSING_SCOPE_BDE

Processing scope BDE, indicating processing scope BDE

PROCESSING_SCOPE_BDE_COMPONENT

public int PROCESSING_SCOPE_BDE_COMPONENT

Processing scope Component, indicating processing scope Component

PROCESSING_SCOPE_NOT_APPLICABLE

public int PROCESSING_SCOPE_NOT_APPLICABLE

Processing scope Not Applicable, indicating processing scope Not Applicable

Constructor Detail

BdeManager

public BdeManager()
           throws BdeException

Method Detail

initialize

public void initialize(java.lang.String backendComponentName)
                throws BdeException

Initialize the manager.

Parameters:

backendComponentName - BusComponent Identifier

Throws:

BdeException - Bde Exception

setTimeOut

public void setTimeOut(long milliseconds)

Set the maximum time the client waits for an repy and before throwing an Communication exception

Parameters:

milliseconds - - The maximum time in milliseconds. If timeout is 0, then synchronous calls wait indefinitely. If timeout < 0 then this functioncall is ignored.

getTimeOut

public long getTimeOut()

Returns the timeout

Returns:

Timeout in milliseconds. Currently configured for this Manager

getIteratorFetchSize

public int getIteratorFetchSize()

Returns the Iterator fetch Size

Returns:

Current configured iterator Fetch size for this Manager

setIteratorFetchSize

public void setIteratorFetchSize(int iteratorSize)

Sets the Iterator fetch Size

Parameters:

iteratorSize - the iterator fetch size to set

ping

public void ping()
          throws BdeException

Try to ping the backend, for testing communication and transports

Throws:

BdeException - If anything goes wrong

close

public void close()
           throws BdeException

Closes this Manager and removes reference to Transport and Activation

Throws:

BdeException - If anything goes wring

setSelection

public void setSelection(IBdeSelection p_selection)

setFilter

public void setFilter(IBdeFilter p_filter)

hasInformation

public boolean hasInformation()

Check this Manager for Warnigs and non-fatal errors

Returns:

Boolean indicating if there are warnings or non-fatal errors

clearInformation

public void clearInformation()

Removes all existing non-fatal errors or warnings from this manager.

getInformation

public IBdeMessageIterator getInformation()
                                   throws BdeException

Returns the information (warnings and non fatal errors) from this manager

Returns:

A MessageIterator

Throws:

BdeException - If anything goes wrong

setProcessingScope

public void setProcessingScope(int pProcessingScope)
                        throws BdeException

supportsProcessingScope

public boolean supportsProcessingScope(int pProcessingScope)
                                throws BdeException

Check if backend supports a certain processing Scope

Parameters:

pProcessingScope - Constant public int PROCESSING_SCOPE_REQUEST, PROCESSING_SCOPE_BDE, PROCESSING_SCOPE_BDE_COMPONENT, PROCESSING_SCOPE_NOT_APPLICABLE

Returns:

true if processing scope is supported

Throws:

BdeException - if anything goes wrong

supportsReferentialIntegrity

public boolean supportsReferentialIntegrity()
                                     throws BdeException

Checks if the backend support the Referential Integrity features

Returns:

true if supported

Throws:

BdeException - if anything goes wrong

automaticReferences

public void automaticReferences(boolean pAutomaticReference)

Enables the automatic creation of References (Locks) by the backend, for example in case of a Show.

Parameters:

pAutomaticReference - boolean indicating if automatic references should be created

createReference

public void createReference(BusinessDataEntity pBde)
                     throws BdeException

Create a Backend reference (lock) for an individual BDE, and it's sub BDEs

Parameters:

pBde - the BDE to create the reference for

Throws:

BdeException - if anything goes wrong

deleteReference

public void deleteReference(BusinessDataEntity pBde)
                     throws BdeException

Delete and remove an backend BDE Reference (lock)

Parameters:

pBde -

Throws:

BdeException - if anything goes wrong