com::pcbsys::nirvana::client::nDeleteResult Class Reference

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

#include <nDeleteResult.h>

Inherits com::pcbsys::nirvana::client::nResult.

Public Member Functions

nChannelAttributesgetAttributes ()
 Get the nChannelAttributes that was used in the create call. More...
 
nChannelgetChannel ()
 If isChannel(), or !isQueue() this method will return the nChannel object created. More...
 
nBaseClientExceptiongetException ()
 If !wasSuccessful(), this will return an Exception. More...
 
nQueuegetQueue ()
 If isQueue(), or !isChannel() this method will return the nQueue object created. More...
 
bool isChannel ()
 Was the result of the create an nChannel. More...
 
bool isQueue ()
 Was the result of the create an nQueue. More...
 
bool wasSuccessful ()
 Determine whether the create was successful for the specific nChannelAttributes object. More...
 

Detailed Description

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

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

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 ( )

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

Returns
the nChannel object
nBaseClientException* com::pcbsys::nirvana::client::nDeleteResult::getException ( )

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

Returns
exception if the create was not successful
nQueue* com::pcbsys::nirvana::client::nDeleteResult::getQueue ( )

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

Returns
the nQueue object
bool com::pcbsys::nirvana::client::nDeleteResult::isChannel ( )

Was the result of the create an nChannel.

Returns
true if an nChannel was created
bool com::pcbsys::nirvana::client::nDeleteResult::isQueue ( )

Was the result of the create an nQueue.

Returns
true if an nQueue was created
bool com::pcbsys::nirvana::client::nDeleteResult::wasSuccessful ( )

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

Returns
true if successful