com.pcbsys.nirvana.client.nResult Class Reference

This class is the base class that represents the results of a batched find, create or delete call for channels or queues. More...

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

Public Member Functions

virtual nChannelAttributes getAttributes ()
 Get the nChannelAttributes that was used in the operation More...
 
virtual nChannel getChannel ()
 If isChannel(), or !isQueue() this method will return the nChannel object found More...
 
virtual nBaseClientException getException ()
 If !wasSuccessful(), this will return an Exception More...
 
virtual nQueue getQueue ()
 If isQueue(), or !isChannel() this method will return the nQueue object More...
 
virtual bool isChannel ()
 Was the result of the operation successfully performed on an nChannel More...
 
virtual bool isQueue ()
 Was the result of the operation successfully performed on an nQueue More...
 
virtual bool wasSuccessful ()
 Determine whether the operation was successful for the specific object More...
 

Detailed Description

This class is the base class that represents the results of a batched find, create or delete call for channels or queues.

Member Function Documentation

virtual nChannelAttributes com.pcbsys.nirvana.client.nResult.getAttributes ( )
virtual
virtual nChannel com.pcbsys.nirvana.client.nResult.getChannel ( )
virtual

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

Returns
the nChannel object

Reimplemented in com.pcbsys.nirvana.client.nDeleteResult, com.pcbsys.nirvana.client.nCreateResult, and com.pcbsys.nirvana.client.nFindResult.

virtual nBaseClientException com.pcbsys.nirvana.client.nResult.getException ( )
virtual

If !wasSuccessful(), this will return an Exception

Returns
exception if the operation was not successful

Reimplemented in com.pcbsys.nirvana.client.nDeleteResult, com.pcbsys.nirvana.client.nCreateResult, and com.pcbsys.nirvana.client.nFindResult.

virtual nQueue com.pcbsys.nirvana.client.nResult.getQueue ( )
virtual

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

Returns
the nQueue object

Reimplemented in com.pcbsys.nirvana.client.nDeleteResult, com.pcbsys.nirvana.client.nCreateResult, and com.pcbsys.nirvana.client.nFindResult.

virtual bool com.pcbsys.nirvana.client.nResult.isChannel ( )
virtual

Was the result of the operation successfully performed on an nChannel

Returns
true if the operation was performed on an nQueue

Reimplemented in com.pcbsys.nirvana.client.nDeleteResult, com.pcbsys.nirvana.client.nCreateResult, and com.pcbsys.nirvana.client.nFindResult.

virtual bool com.pcbsys.nirvana.client.nResult.isQueue ( )
virtual

Was the result of the operation successfully performed on an nQueue

Returns
true if the operation was performed on an nQueue

Reimplemented in com.pcbsys.nirvana.client.nDeleteResult, com.pcbsys.nirvana.client.nCreateResult, and com.pcbsys.nirvana.client.nFindResult.

virtual bool com.pcbsys.nirvana.client.nResult.wasSuccessful ( )
virtual

Determine whether the operation was successful for the specific object

Returns
true if successful

Reimplemented in com.pcbsys.nirvana.client.nDeleteResult, com.pcbsys.nirvana.client.nCreateResult, and com.pcbsys.nirvana.client.nFindResult.