Public Member Functions
com.pcbsys.nirvana.client.nFindResult Class Reference

This class represents the results of the nSession.find(nChannelAttributes[]) call. More...

Inheritance diagram for com.pcbsys.nirvana.client.nFindResult:
com.pcbsys.nirvana.client.nResult

Public Member Functions

nChannelAttributes getAttributes ()
 Get the nChannelAttributes that was used in the find call. More...
 
nChannel getChannel ()
 If isChannel(), or !isQueue() this method will return the nChannel object found. More...
 
nBaseClientException getException ()
 If !wasSuccessful(), this will return an Exception. More...
 
nQueue getQueue ()
 If isQueue(), or !isChannel() this method will return the nQueue object found. More...
 
boolean isChannel ()
 Was the result of the find an nChannel. More...
 
boolean isQueue ()
 Was the result of the find an nQueue. More...
 
boolean wasSuccessful ()
 Determine whether the find was successful for the specific nChannelAttributes object. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.nResult
nChannelAttributes getAttributes ()
 Get the nChannelAttributes that was used in the operation. More...
 
nChannel getChannel ()
 If isChannel(), or !isQueue() this method will return the nChannel object found. More...
 
nBaseClientException getException ()
 If !wasSuccessful(), this will return an Exception. More...
 
nQueue getQueue ()
 If isQueue(), or !isChannel() this method will return the nQueue object. More...
 
boolean isChannel ()
 Was the result of the operation successfully performed on an nChannel. More...
 
boolean isQueue ()
 Was the result of the operation successfully performed on an nQueue. More...
 
boolean wasSuccessful ()
 Determine whether the operation was successful for the specific object. More...
 

Detailed Description

This class represents the results of the nSession.find(nChannelAttributes[]) call.

This call returns an array of nFindResult objects, each one represents the result of the call. The result will either be an nChannel, nQueue or an Exception object

Since
6.0

Member Function Documentation

nChannelAttributes com.pcbsys.nirvana.client.nFindResult.getAttributes ( )

Get the nChannelAttributes that was used in the find call.

Returns
the nChannelAttributes object
nChannel com.pcbsys.nirvana.client.nFindResult.getChannel ( )

If isChannel(), or !isQueue() this method will return the nChannel object found.

Returns
the nChannel object
nBaseClientException com.pcbsys.nirvana.client.nFindResult.getException ( )

If !wasSuccessful(), this will return an Exception.

Returns
exception if the find was not successful
nQueue com.pcbsys.nirvana.client.nFindResult.getQueue ( )

If isQueue(), or !isChannel() this method will return the nQueue object found.

Returns
the nQueue object
boolean com.pcbsys.nirvana.client.nFindResult.isChannel ( )

Was the result of the find an nChannel.

Returns
true if an nChannel was found
boolean com.pcbsys.nirvana.client.nFindResult.isQueue ( )

Was the result of the find an nQueue.

Returns
true if an nQueue was found
boolean com.pcbsys.nirvana.client.nFindResult.wasSuccessful ( )

Determine whether the find was successful for the specific nChannelAttributes object.

Returns
true if successful