com.daveoxley.cbus

Class Network

java.lang.Object

com.daveoxley.cbus.CGateObject

com.daveoxley.cbus.Network

All Implemented Interfaces:

java.lang.Comparable<Network>

public final class Network
extends CGateObject
implements java.lang.Comparable<Network>

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Network o)
Application	getApplication(int application_id) Retrieve the Unit Object for the specified unit id.
java.util.ArrayList<Application>	getApplications(boolean cached_objects) Get all Application objects for this Network.
CGateObject	getCGateObject(java.lang.String address)
java.lang.String	getInterfaceAddress()
protected java.lang.String	getKey()
java.lang.String	getName()
int	getNetworkID()
Project	getProject()
java.lang.String	getProjectName()
java.lang.String	getState()
java.lang.String	getType()
Unit	getUnit(int unit_id) Retrieve the Unit Object for the specified unit id.
java.util.ArrayList<Unit>	getUnits(boolean cached_objects)
static java.util.ArrayList<Network>	listAll(CGateSession cgate_session, boolean cached_objects) Issue a net list_all to the C-Gate server.
void	open() Issue a net open //PROJECT/NET_ID to the C-Gate server.

Methods inherited from class com.daveoxley.cbus.CGateObject

cacheObject, clearCache, clearCache, getAddress, getAllCachedObjects, getCachedObject, getCGateSession, setupSubtreeCache, uncacheObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getKey

protected java.lang.String getKey()

Specified by:

getKey in class CGateObject

getCGateObject

public CGateObject getCGateObject(java.lang.String address)
                           throws CGateException

Specified by:

getCGateObject in class CGateObject

Throws:

CGateException

compareTo

public int compareTo(Network o)

Specified by:

compareTo in interface java.lang.Comparable<Network>

listAll

public static java.util.ArrayList<Network> listAll(CGateSession cgate_session,
                                   boolean cached_objects)
                                            throws CGateException

Issue a net list_all to the C-Gate server.

Parameters:

cgate_session - The C-Gate session

cached_objects - Return cached Project objects or rebuild list from C-Gate

Returns:

ArrayList of Networks

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.63

getApplication

public Application getApplication(int application_id)
                           throws CGateException

Retrieve the Unit Object for the specified unit id.

Parameters:

unit_id - The unit to retrieve

Returns:

The Unit

Throws:

CGateException

getUnit

public Unit getUnit(int unit_id)
             throws CGateException

Retrieve the Unit Object for the specified unit id.

Parameters:

unit_id - The unit to retrieve

Returns:

The Unit

Throws:

CGateException

getNetworkID

public int getNetworkID()

Returns:

getProject

public Project getProject()

getProjectName

public java.lang.String getProjectName()

getName

public java.lang.String getName()
                         throws CGateException

Throws:

CGateException

getType

public java.lang.String getType()
                         throws CGateException

Throws:

CGateException

getInterfaceAddress

public java.lang.String getInterfaceAddress()
                                     throws CGateException

Throws:

CGateException

getState

public java.lang.String getState()
                          throws CGateException

Throws:

CGateException

getUnits

public java.util.ArrayList<Unit> getUnits(boolean cached_objects)
                                   throws CGateException

Throws:

CGateException

open

public void open()
          throws CGateException

Issue a net open //PROJECT/NET_ID to the C-Gate server.

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.65

getApplications

public java.util.ArrayList<Application> getApplications(boolean cached_objects)
                                                 throws CGateException

Get all Application objects for this Network.

Parameters:

cached_objects - Return cached Project objects or rebuild list from C-Gate

Returns:

ArrayList of Applications

Throws:

CGateException