com.pcbsys.nirvana.client.nDeleteResult Class Reference

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

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

Public Member Functions

override nChannelAttributes getAttributes ()
 Get the nChannelAttributes that was used in the create call More...
 
override nChannel getChannel ()
 This method will return null More...
 
override nBaseClientException getException ()
 If !wasSuccessful(), this will return an Exception More...
 
override nQueue getQueue ()
 This method will return null More...
 
override bool isChannel ()
 Was the result of the delete an nChannel More...
 
override bool isQueue ()
 Was the result of the delete an nQueue More...
 
override bool wasSuccessful ()
 Determine whether the delete was successful for the specific nChannelAttributes object More...
 

Detailed Description

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

This call returns an array of nDeleteResult objects, each one represents the result of the call. The result will either be show as wasSuccessful() or contain an Exception object

Member Function Documentation

override nChannelAttributes com.pcbsys.nirvana.client.nDeleteResult.getAttributes ( )
virtual

Get the nChannelAttributes that was used in the create call

Returns
the nChannelAttributes object

Reimplemented from com.pcbsys.nirvana.client.nResult.

override nChannel com.pcbsys.nirvana.client.nDeleteResult.getChannel ( )
virtual

This method will return null

Returns
null

Reimplemented from com.pcbsys.nirvana.client.nResult.

override nBaseClientException com.pcbsys.nirvana.client.nDeleteResult.getException ( )
virtual

If !wasSuccessful(), this will return an Exception

Returns
exception if the delete was not successful

Reimplemented from com.pcbsys.nirvana.client.nResult.

override nQueue com.pcbsys.nirvana.client.nDeleteResult.getQueue ( )
virtual

This method will return null

Returns
null

Reimplemented from com.pcbsys.nirvana.client.nResult.

override bool com.pcbsys.nirvana.client.nDeleteResult.isChannel ( )
virtual

Was the result of the delete an nChannel

Returns
true if an nChannel was deleted

Reimplemented from com.pcbsys.nirvana.client.nResult.

override bool com.pcbsys.nirvana.client.nDeleteResult.isQueue ( )
virtual

Was the result of the delete an nQueue

Returns
true if an nQueue was deleted

Reimplemented from com.pcbsys.nirvana.client.nResult.

override bool com.pcbsys.nirvana.client.nDeleteResult.wasSuccessful ( )
virtual

Determine whether the delete was successful for the specific nChannelAttributes object

Returns
true if successful

Reimplemented from com.pcbsys.nirvana.client.nResult.