com.pcbsys.nirvana.client.nCreateResult Class Reference

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

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

Public Member Functions

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

Since
7.0

Member Function Documentation

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

Get the nChannelAttributes that was used in the create call.

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

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

Returns
the nChannel object
nBaseClientException com.pcbsys.nirvana.client.nCreateResult.getException ( )

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

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

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

Returns
the nQueue object or null depending on isQueue
boolean com.pcbsys.nirvana.client.nCreateResult.isChannel ( )

Was the result of the create an nChannel.

Returns
true if an nChannel was created
boolean com.pcbsys.nirvana.client.nCreateResult.isQueue ( )

Was the result of the create an nQueue.

Returns
true if an nQueue was created
boolean com.pcbsys.nirvana.client.nCreateResult.wasSuccessful ( )

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

Returns
true if successful