|
webMethods Admin Version 7.1.0.0.211 082207 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectCOM.activesw.api.client.BrokerClientQueueBrowser
public class BrokerClientQueueBrowser
This class provides queue browsing capabilities to view events from client queue.
Method Summary | |
---|---|
BrokerEvent[] |
browseEvents(int max_events,
int msecs)
Browse one or more events from the queue. |
void |
closeQueueBrowser()
Close the current queue browser object. |
BrokerClientQueueBrowserInfo |
getBrowserInfo()
Get information on the current queue browser. |
COM.activesw.api.client.BrokerFilterDescriptor[] |
getFilters()
Get the current filters set on the queue browser. |
void |
resetFilters()
Remove all existing filters on the queue browser. |
void |
setFilter(COM.activesw.api.client.BrokerFilterDescriptor filter)
Set filter for queue browser's browse operation. |
void |
setFilters(COM.activesw.api.client.BrokerFilterDescriptor[] filters)
Set filters for queue browser's browse operation. |
void |
setPosition(int position)
Set the browse cursor to the specified psotion on the queue. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public BrokerClientQueueBrowserInfo getBrowserInfo() throws BrokerException
BrokerException
public void setPosition(int position) throws BrokerException
position
- The queue position to set
BrokerInvalidClientException
- If the client has been
destroyed or disconnected.
BrokerClientQueueBrowserException
- If the position is out
of bounds or the queue is exhausted.
BrokerException
public void setFilter(COM.activesw.api.client.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
public void setFilters(COM.activesw.api.client.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
public void resetFilters() throws BrokerException
BrokerException
public COM.activesw.api.client.BrokerFilterDescriptor[] getFilters() throws BrokerException
BrokerException
public 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
public void closeQueueBrowser() throws BrokerException
BrokerException
|
webMethods Admin Version 7.1.0.0.211 082207 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |