com.pcbsys.nirvana.client.nDurableAttributes Class Reference

Container which holds the attributes required for describing a durable object on a channel. More...

Inherited by com.pcbsys.nirvana.client.nSerialDurableAttributes, and com.pcbsys.nirvana.client.nSharedDurableAttributes.

Public Types

enum  nDurableType
 Enumeration defining all durable types. More...
 

Public Member Functions

string getName ()
 Returns the name of the durable object. More...
 
string getSelector ()
 Selector that is going to be used on the durable object to filter events. More...
 
long getStartEid ()
 Starting event ID of the durable that will be created from the attributes. More...
 
nDurableType getType ()
 Returns the type of the durable. More...
 
void setSelector (string selector)
 Setting the selector that is going to be used on the durable object to filter events. More...
 
void setStartEid (long startEid)
 Sets the starting event ID of the durable that will be created from the attributes. More...
 

Static Public Member Functions

static nDurableAttributes create (nDurableType type, string name)
 Creates a durable attributes instance with the specified durable type and name. More...
 

Detailed Description

Container which holds the attributes required for describing a durable object on a channel.

Member Enumeration Documentation

Enumeration defining all durable types.

Member Function Documentation

static nDurableAttributes com.pcbsys.nirvana.client.nDurableAttributes.create ( nDurableType  type,
string  name 
)
static

Creates a durable attributes instance with the specified durable type and name.

Parameters
typeRequested durbale type
nameThe name of the durable object
Returns
The created durable attributes instance
string com.pcbsys.nirvana.client.nDurableAttributes.getName ( )

Returns the name of the durable object.

Returns
Name of the durable object
string com.pcbsys.nirvana.client.nDurableAttributes.getSelector ( )

Selector that is going to be used on the durable object to filter events.

Returns
selector used as an event filter
long com.pcbsys.nirvana.client.nDurableAttributes.getStartEid ( )

Starting event ID of the durable that will be created from the attributes.

Returns
Id of the starting event
nDurableType com.pcbsys.nirvana.client.nDurableAttributes.getType ( )

Returns the type of the durable.

Returns
Durable type
void com.pcbsys.nirvana.client.nDurableAttributes.setSelector ( string  selector)

Setting the selector that is going to be used on the durable object to filter events.

Parameters
selectorString that will be used as an event filter.
Exceptions
nIllegalArgumentExceptionThrown in case a selector is attempted to be added on non-shared durable type
void com.pcbsys.nirvana.client.nDurableAttributes.setStartEid ( long  startEid)

Sets the starting event ID of the durable that will be created from the attributes.

Parameters
startEidStarting event Id to be set