public interface BrokerQueueBrowser
Modifier and Type | Method and Description |
---|---|
BrokerEvent[] |
browseEvents(int max_events,
int msecs)
Browse one or more events from the queue.
|
void |
closeQueueBrowser()
Close the current queue browser object.
|
BrokerQueueBrowserInfo |
getBrowserInfo()
Get information on the current queue browser.
|
BrokerFilterDescriptor[] |
getFilters()
Get the current filters set on the queue browser.
|
void |
resetFilters()
Remove all existing filters on the queue browser.
|
void |
setFilter(BrokerFilterDescriptor filter)
Set filter for queue browser's browse operation.
|
void |
setFilters(BrokerFilterDescriptor[] filters)
Set filters for queue browser's browse operation.
|
void |
setPosition(int position)
Set the browse cursor to the specified position on the queue.
|
BrokerQueueBrowserInfo getBrowserInfo() throws BrokerException
BrokerException
void setPosition(int position) throws BrokerException
position
- The queue position to setBrokerInvalidClientException
- If the client has been destroyed or disconnected.BrokerQueueBrowserException
- If the position is out of bounds or the queue is exhausted.BrokerException
void setFilter(BrokerFilterDescriptor filter) throws BrokerException
BrokerNullParameterException
- If description is null.BrokerUnknownEventTypeException
- If no events exist in the specified scope on the broker.BrokerInvalidFilterException
- If the specified filter expression is invalid.BrokerException
void setFilters(BrokerFilterDescriptor[] filters) throws BrokerException
BrokerNullParameterException
- If description is null.BrokerUnknownEventTypeException
- If no events exist in the specified scope on the broker.BrokerInvalidFilterException
- If the specified filter expression is invalid.BrokerException
void resetFilters() throws BrokerException
BrokerException
BrokerFilterDescriptor[] getFilters() throws BrokerException
BrokerException
BrokerEvent[] browseEvents(int max_events, int msecs) throws BrokerException
BrokerInvalidClientException
- If the client has been destroyed or disconnected.BrokerTimeoutException
- If the timeout is reached before any events arrive.BrokerException
void closeQueueBrowser() throws BrokerException
BrokerException
Copyright © 2002-2006 webMethods, Inc. Copyright © 2007-2021 Software AG Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.