com.pcbsys.nirvana.client.nDeleteResult Class Reference

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

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

Public Member Functions

nChannelAttributes getAttributes ()
 Get the nChannelAttributes that was used in the create call. More...
 
nChannel getChannel ()
 This method will return null. More...
 
nBaseClientException getException ()
 If !wasSuccessful(), this will return an Exception. More...
 
nQueue getQueue ()
 This method will return null. More...
 
boolean isChannel ()
 Was the result of the delete an nChannel. More...
 
boolean isQueue ()
 Was the result of the delete an nQueue. More...
 
boolean wasSuccessful ()
 Determine whether the delete 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.deleteResources(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

Since
7.0

Member Function Documentation

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

Get the nChannelAttributes that was used in the create call.

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

This method will return null.

Returns
null
nBaseClientException com.pcbsys.nirvana.client.nDeleteResult.getException ( )

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

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

This method will return null.

Returns
null
boolean com.pcbsys.nirvana.client.nDeleteResult.isChannel ( )

Was the result of the delete an nChannel.

Returns
true if an nChannel was deleted
boolean com.pcbsys.nirvana.client.nDeleteResult.isQueue ( )

Was the result of the delete an nQueue.

Returns
true if an nQueue was deleted
boolean com.pcbsys.nirvana.client.nDeleteResult.wasSuccessful ( )

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

Returns
true if successful