com.pcbsys.nirvana.client.nFindResult

Package	com.pcbsys.nirvana.client
Class	public class nFindResult
Inheritance	nFindResult Object

Since :

6.0

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 object

Public Properties

	Property		Defined By
		attributes : nStoreAttributes [read-only] Get the nChannelAttributes that was used in the find call	nFindResult
		channel : nChannel [read-only] If isChannel(), or !isQueue() this method will return the nChannel object found	nFindResult
		error : Error [read-only] If !wasSuccessful(), this will return an Exception	nFindResult
		queue : nQueue [read-only] If isQueue(), or !isChannel() this method will return the nQueue object found	nFindResult

Public Methods

	Method		Defined By
		isChannel():Boolean Was the result of the find an nChannel	nFindResult
		isQueue():Boolean Was the result of the find an nQueue	nFindResult
		wasSuccessful():Boolean Determine whether the find was successful for the specific nChannelAttributes object	nFindResult

Property Detail

attributes

property

attributes:nStoreAttributes [read-only]

Get the nChannelAttributes that was used in the find call

Implementation
public function get attributes():nStoreAttributes

channel

property

channel:nChannel [read-only]

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

Implementation
public function get channel():nChannel

error

property

error:Error [read-only]

If !wasSuccessful(), this will return an Exception

Implementation
public function get error():Error

queue

property

queue:nQueue [read-only]

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

Implementation
public function get queue():nQueue

Method Detail

isChannel

()

method

public function isChannel():Boolean

Was the result of the find an nChannel

Returns

Boolean — true if an nChannel was found

isQueue

()

method

public function isQueue():Boolean

Was the result of the find an nQueue

Returns

Boolean — true if an nQueue was found

wasSuccessful

()

method

public function wasSuccessful():Boolean

Determine whether the find was successful for the specific nChannelAttributes object

Returns

Boolean — true if successful