com.ssaglobal.bde
Interface IPublishControl

public interface IPublishControl

This IPublishControl interface can be used to store the controlling attributes for the publishing methods. Note that the individual Publishing methods require different attributes.

Method Summary

void	addEventAction(java.lang.String value) Add an eventAction to this PublishControl If no eventAction is supplied, the subscription is done on all BDE related events.
boolean	hasDestination() Has destination attribute.
boolean	hasEventBatchSize() Has eventBatchSize attribute.
boolean	hasMaxNumberOfObjects() Has maxNumberOfObjects attribute.
void	setDestination(java.lang.String value) Set destination attribute.
void	setEventBatchSize(int value) Set eventBatchSize attribute.
void	setMaxNumberOfObjects(int value) Set maxNumberOfObjects attribute.
void	unsetAllEventAction() Removes all eventActions from this PublishControl
void	unsetDestination() Unset destination attribute.
void	unsetEventBatchSize() Unset eventBatchSize attribute.
void	unsetMaxNumberOfObjects() Unset maxNumberOfObjects attribute.

Method Detail

setMaxNumberOfObjects

public void setMaxNumberOfObjects(int value)
                           throws BdeException

Set maxNumberOfObjects attribute. A user can limit the amount of instances to be pushed out by setting this attribute to the maximum valued required.
The functionality is equal to the maxNumberOfObjects functionality of the 'standard' List BDE Method.

Parameters:

value - the maxNumberOfObjects to set

Throws:

BdeException - if maxNumberOfObjects cannot be set.

hasMaxNumberOfObjects

public boolean hasMaxNumberOfObjects()

Has maxNumberOfObjects attribute.

Returns:

true if maxNumberOf Objects is set

unsetMaxNumberOfObjects

public void unsetMaxNumberOfObjects()

Unset maxNumberOfObjects attribute.

setEventBatchSize

public void setEventBatchSize(int value)
                       throws BdeException

Set eventBatchSize attribute. Because an entire list of instances to be pushed out can be rather large, they can be pushed out in batches.
The maximum number of objects that should be pushed out in one batch can be controlled by the eventBatchSize. If this attribute does not exist or has been set to 0, the application server will return the entire set of requested objects in one batch. If the eventBatchSize specified by the client is smaller than the amount of objects to be pushed out, the application server will push out the instances in multiple batches of size equal to eventBatchSize. Inside the event the controlling attribute eventHasMoreBatches indicates whether there are more batches to be pushed out. If this attribute either does not exist or is set to false, the entire list has been pushed out.

Parameters:

value - sets the eventBatchSize in this PublishControl

Throws:

BdeException - if eventBatchSize cannot be set

hasEventBatchSize

public boolean hasEventBatchSize()

Has eventBatchSize attribute.

Returns:

true if eventBatchSize is set

unsetEventBatchSize

public void unsetEventBatchSize()

Unset eventBatchSize attribute.

setDestination

public void setDestination(java.lang.String value)
                    throws BdeException

Set destination attribute. This identifies the communication channel (BusComponent ID) to which the list needs to be published.
If a destination is not supplied, the default destination will be used instead.

Parameters:

value - the Destination to set

Throws:

BdeException - if destinatino cannot be set

hasDestination

public boolean hasDestination()

Has destination attribute.

Returns:

boolean indicating an Destination is set

unsetDestination

public void unsetDestination()

Unset destination attribute.

addEventAction

public void addEventAction(java.lang.String value)

Add an eventAction to this PublishControl If no eventAction is supplied, the subscription is done on all BDE related events.

Parameters:

value - the eventAction to add

unsetAllEventAction

public void unsetAllEventAction()

Removes all eventActions from this PublishControl