com::pcbsys::nirvana::client::nFindResult Class Reference

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

#include <nFindResult.h>

Public Member Functions
virtual nChannelAttributes *	getAttributes ()
	Get the nChannelAttributes that was used in the find call. 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 found. More...
virtual bool	isChannel ()
	Was the result of the find an nChannel. More...
virtual bool	isQueue ()
	Was the result of the find an nQueue. More...
virtual bool	wasSuccessful ()
	Determine whether the find was successful for the specific nChannelAttributes 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 obhect

Since

6.0

Member Function Documentation

virtual nChannelAttributes* com::pcbsys::nirvana::client::nFindResult::getAttributes ( )

virtual

Get the nChannelAttributes that was used in the find call.

Returns

the nChannelAttributes object

virtual nChannel* com::pcbsys::nirvana::client::nFindResult::getChannel ( )

virtual

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

Returns

the nChannel object

virtual nBaseClientException* com::pcbsys::nirvana::client::nFindResult::getException ( )

virtual

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

Returns

exception if the find was not successful

virtual nQueue* com::pcbsys::nirvana::client::nFindResult::getQueue ( )

virtual

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

Returns

the nQueue object

virtual bool com::pcbsys::nirvana::client::nFindResult::isChannel ( )

virtual

Was the result of the find an nChannel.

Returns

true if an nChannel was found

virtual bool com::pcbsys::nirvana::client::nFindResult::isQueue ( )

virtual

Was the result of the find an nQueue.

Returns

true if an nQueue was found

virtual bool com::pcbsys::nirvana::client::nFindResult::wasSuccessful ( )

virtual

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

Returns

true if successful