Package 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, BroadWorksUser, Group, ServiceProvider
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:

  • Field Details

    • broadWorksServer

      protected transient BroadWorksServer broadWorksServer

    • populated

      protected boolean populated

  • Constructor Details

    • 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 Details

    • 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

      public abstract <E extends Response> E populate() throws RequestException, BroadWorksObjectException
      Throws:
      RequestException
      BroadWorksObjectException

    • isPopulated

      public boolean isPopulated()

    • setPopulated

      public void setPopulated(boolean populated)