com.daveoxley.cbus

Class Group

java.lang.Object

com.daveoxley.cbus.CGateObject

com.daveoxley.cbus.Group

All Implemented Interfaces:

java.lang.Comparable<Group>

public class Group
extends CGateObject
implements java.lang.Comparable<Group>

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Group o)
Application	getApplication()
CGateObject	getCGateObject(java.lang.String address)
int	getGroupID()
protected java.lang.String	getKey()
int	getLevel() Issue a get //PROJECT/NET_ID/GROUP_ID Level to the C-Gate server.
java.lang.String	getName()
Network	getNetwork()
Response	off() Issue a off //PROJECT/NET_ID/GROUP_ID to the C-Gate server.
Response	on() Issue a on //PROJECT/NET_ID/GROUP_ID to the C-Gate server.
Response	ramp(int level, int seconds) Issue a ramp //PROJECT/NET_ID/GROUP_ID to the C-Gate server.
Response	terminateRamp(boolean force) Issue a terminate_ramp //PROJECT/NET_ID/GROUP_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(Group o)

Specified by:

compareTo in interface java.lang.Comparable<Group>

getGroupID

public int getGroupID()

Returns:

getApplication

public Application getApplication()

Returns:

getNetwork

public Network getNetwork()

Returns:

getName

public java.lang.String getName()
                         throws CGateException

Throws:

CGateException

on

public Response on()
            throws CGateException

Issue a on //PROJECT/NET_ID/GROUP_ID to the C-Gate server.

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.79

off

public Response off()
             throws CGateException

Issue a off //PROJECT/NET_ID/GROUP_ID to the C-Gate server.

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.77

ramp

public Response ramp(int level,
            int seconds)
              throws CGateException

Issue a ramp //PROJECT/NET_ID/GROUP_ID to the C-Gate server.

Parameters:

level -

seconds -

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.100

terminateRamp

public Response terminateRamp(boolean force)
                       throws CGateException

Issue a terminate_ramp //PROJECT/NET_ID/GROUP_ID to the C-Gate server.

Parameters:

force -

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.123

getLevel

public int getLevel()
             throws CGateException

Issue a get //PROJECT/NET_ID/GROUP_ID Level to the C-Gate server.

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.44