com.daveoxley.cbus

Class Project

java.lang.Object

com.daveoxley.cbus.CGateObject

com.daveoxley.cbus.Project

All Implemented Interfaces:

java.lang.Comparable<Project>

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

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Issue a project close project_name to the C-Gate server.
int	compareTo(Project o)
Project	copy(java.lang.String target_project_name) Issue a project copy source project_name copy project_name to the C-Gate server.
void	delete() Issue a project delete project_name to the C-Gate server.
static java.util.ArrayList<Project>	dir(CGateSession cgate_session, boolean cached_objects) Issue a project dir and project list to the C-Gate server.
CGateObject	getCGateObject(java.lang.String address)
protected java.lang.String	getKey()
java.lang.String	getName() Get the project name.
Network	getNetwork(int network_id) Retrieve the Network Object for the specified network id.
java.util.ArrayList<Network>	getNetworks(boolean cached_objects) Get all Network objects for this Project.
static Project	getProject(CGateSession cgate_session, java.lang.String project_name) Retrieve the Project Object for the specified project name.
static java.util.ArrayList<Project>	list(CGateSession cgate_session, boolean cached_objects) Issue a project dir to the C-Gate server.
void	load() Issue a project load project_name to the C-Gate server.
static Project	newProject(CGateSession cgate_session, java.lang.String project_name) Issue a project new project_name to the C-Gate server.
void	save() Issue a project save project_name to the C-Gate server.
void	start() Issue a project start project_name 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(Project o)

Specified by:

compareTo in interface java.lang.Comparable<Project>

dir

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

Issue a project dir and project list 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 Projects

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.89

list

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

Issue a project dir 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 Projects

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.90

newProject

public static Project newProject(CGateSession cgate_session,
                 java.lang.String project_name)
                          throws CGateException

Issue a project new project_name to the C-Gate server.

Parameters:

cgate_session - The C-Gate session

project_name - The project name of the new copy

Returns:

Project The new Project

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.92

getProject

public static Project getProject(CGateSession cgate_session,
                 java.lang.String project_name)
                          throws CGateException

Retrieve the Project Object for the specified project name.

Parameters:

cgate_session - The CGateSession

project_name - The project name to retrieve

Returns:

The Project

Throws:

CGateException

getNetwork

public Network getNetwork(int network_id)
                   throws CGateException

Retrieve the Network Object for the specified network id.

Parameters:

network_id - The network to retrieve

Returns:

The Network

Throws:

CGateException

getNetworks

public java.util.ArrayList<Network> getNetworks(boolean cached_objects)
                                         throws CGateException

Get all Network objects for this Project.

Parameters:

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

Returns:

ArrayList of Networks

Throws:

CGateException

getName

public java.lang.String getName()

Get the project name.

Returns:

The project name

close

public void close()
           throws CGateException

Issue a project close project_name to the C-Gate server.

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.86

copy

public Project copy(java.lang.String target_project_name)
             throws CGateException

Issue a project copy source project_name copy project_name to the C-Gate server.

Parameters:

project_name - The project name of the new copy

Returns:

Project The new copy of the current Project

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.87

delete

public void delete()
            throws CGateException

Issue a project delete project_name to the C-Gate server.

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.88

load

public void load()
          throws CGateException

Issue a project load project_name to the C-Gate server.

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.91

start

public void start()
           throws CGateException

Issue a project start project_name to the C-Gate server.

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.96

save

public void save()
          throws CGateException

Issue a project save project_name to the C-Gate server.

Throws:

CGateException

See Also:

C-Gate Server Guide 4.3.95