com::pcbsys::nirvana::nAdminAPI::nClusterStatusEntry Class Reference

This class contains the online/offline status for a realm within a cluster. More...

#include <nClusterStatusEntry.h>

Inherits Observable.

Public Member Functions

virtual const std::string & getName ()
 The realm name which this status belongs to. More...
 
virtual bool isOnline ()
 Return the status of the realms online/offline. More...
 

Protected Member Functions

 nClusterStatusEntry (const std::string &name, bool conState)
 Creates a new nClusterStatusEntry for the specified name. More...
 
virtual void setState (bool newState)
 set the Boolean indicating if the realm is online or offline More...
 

Detailed Description

This class contains the online/offline status for a realm within a cluster.

Constructor & Destructor Documentation

com::pcbsys::nirvana::nAdminAPI::nClusterStatusEntry::nClusterStatusEntry ( const std::string &  name,
bool  conState 
)
protected

Creates a new nClusterStatusEntry for the specified name.

Parameters
namethe string name of the realm within the cluster
boolthe boolean status of the realm true/false(online/offline)

Member Function Documentation

virtual const std::string& com::pcbsys::nirvana::nAdminAPI::nClusterStatusEntry::getName ( )
virtual

The realm name which this status belongs to.

Returns
Realm name
virtual bool com::pcbsys::nirvana::nAdminAPI::nClusterStatusEntry::isOnline ( )
virtual

Return the status of the realms online/offline.

Returns
bool indicating if the realm is online
virtual void com::pcbsys::nirvana::nAdminAPI::nClusterStatusEntry::setState ( bool  newState)
protectedvirtual

set the Boolean indicating if the realm is online or offline

Parameters
newStatebool indicating if the realm is online