co.ecg.alpaca.toolkit.model

Class BroadWorksObject

java.lang.Object

co.ecg.alpaca.toolkit.model.BroadWorksObject

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AccessDevice, BroadWorksService, Group, ServiceProvider, User

public abstract class BroadWorksObject
extends Object
implements Serializable

Defines a modeled object from within the BroadWorks system. Modeled objects are those that have expected relationships. E.G. User, ServiceProvider, Group, and Access Device. These are not returned in such a fashion from BroadWorks. However, each object is assigned a population command that forms the core of what is expected from this object. In the case of User, the object is mapped to a specific UserRequest. The fields contained in the response then are seen as the POJO variables for the User.

Author:

Matthew Keathley - mkeathley@e-c-group.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BroadWorksServer	broadWorksServer
protected boolean	populated

Constructor Summary

Constructors

Constructor and Description
BroadWorksObject() Serializable Constructor
BroadWorksObject(BroadWorksServer broadWorksServer) Default Constructor to assign the BroadWorksServer for the Object.

Method Summary

Modifier and Type	Method and Description
BroadWorksServer	getBroadWorksServer() Returns the backing BroadWorksServer connection for the object.
boolean	hasPopulated() Returns true if the object has had it's variables populated with data from BroadWorks.
boolean	isPopulated()
abstract <E extends Response> E	populate()
void	setBroadWorksServer(BroadWorksServer broadWorksServer) Sets the backing BroadWorksServer connection for the object.
void	setPopulated(boolean populated)

Methods inherited from class java.lang.Object

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

Field Detail

broadWorksServer

protected transient BroadWorksServer broadWorksServer

populated

protected boolean populated

Constructor Detail

BroadWorksObject

public BroadWorksObject()

Serializable Constructor

BroadWorksObject

public BroadWorksObject(BroadWorksServer broadWorksServer)

Default Constructor to assign the BroadWorksServer for the Object.

Parameters:

broadWorksServer - The BroadWorksServer for the Object.

Method Detail

getBroadWorksServer

public BroadWorksServer getBroadWorksServer()

Returns the backing BroadWorksServer connection for the object.

Returns:

The BroadWorksServer

setBroadWorksServer

public void setBroadWorksServer(BroadWorksServer broadWorksServer)

Sets the backing BroadWorksServer connection for the object.

hasPopulated

public boolean hasPopulated()

Returns true if the object has had it's variables populated with data from BroadWorks.

Returns:

populated

populate

@GwtIncompatible
public abstract <E extends Response> E populate()
                                                          throws RequestException,
                                                                 BroadWorksObjectException

Throws:

RequestException

BroadWorksObjectException

isPopulated

public boolean isPopulated()

setPopulated

public void setPopulated(boolean populated)