com.buildforge.services.common.dbo
Class InterfaceDBO

java.lang.Object
  extended by com.buildforge.services.common.dbo.DBObject
      extended by com.buildforge.services.common.dbo.InterfaceDBO

public class InterfaceDBO
extends DBObject

Database information representing an adaptor. Adaptors used to be called interfaces in the Build Forge system, and the vestigal name has been retained by this class for the time being.


Nested Class Summary
static class InterfaceDBO.Type
          Identifies what type of adapter this is.
 
Field Summary
static java.lang.Class<InterfaceDBO> CLASS
           
static java.lang.String TYPE_KEY
           
 
Constructor Summary
InterfaceDBO()
           
 
Method Summary
 InterfaceDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 java.lang.String getDataKey()
           
 java.lang.String getDataText()
           
 java.lang.String getInterfaceId()
           
 int getLevel()
           
 int getLineId()
           
 java.lang.String getLiveInterfaceId()
           
 java.lang.String getTemplate()
           
 InterfaceDBO.Type getType()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 boolean isLive()
          Checks whether or not the object is live.
static void sanityCheck(java.lang.String interfaceId)
           
 void setDataKey(java.lang.String dataKey)
           
 void setDataText(java.lang.String dataText)
           
 void setInterfaceId(java.lang.String interfaceId)
           
 void setLevel(int level)
           
 void setLineId(int id)
           
 void setLiveInterfaceId(java.lang.String newId)
           
 void setTemplate(java.lang.String template)
           
 void setType(InterfaceDBO.Type type)
           
 java.lang.Object[] toArray()
          Serializes this database object as an array of objects.
 java.lang.String toString()
           
 
Methods inherited from class com.buildforge.services.common.dbo.DBObject
badId, badName, checkDead, checkLive, collision, collision
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_KEY

public static final java.lang.String TYPE_KEY
See Also:
Constant Field Values

CLASS

public static final java.lang.Class<InterfaceDBO> CLASS
Constructor Detail

InterfaceDBO

public InterfaceDBO()
Method Detail

getTypeKey

public java.lang.String getTypeKey()
Description copied from class: DBObject
Retrieve the key that should be used to look up the display name for a data type.

Specified by:
getTypeKey in class DBObject
Returns:
the type key for this object's class

isLive

public boolean isLive()
Description copied from class: DBObject
Checks whether or not the object is live. Note that this is not valid for object types that do not have a unique identifier. Those for which no reasonable implementation exists should always return false.

Specified by:
isLive in class DBObject
Returns:
true iff liveness is a valid concept for this object, and the object is live; otherwise, false is returned.

getDataKey

public java.lang.String getDataKey()

getDataText

public java.lang.String getDataText()

getInterfaceId

public java.lang.String getInterfaceId()

getLevel

public int getLevel()

getLineId

public int getLineId()

getLiveInterfaceId

public java.lang.String getLiveInterfaceId()

getTemplate

public java.lang.String getTemplate()

getType

public InterfaceDBO.Type getType()

setDataKey

public void setDataKey(java.lang.String dataKey)

setDataText

public void setDataText(java.lang.String dataText)

setInterfaceId

public void setInterfaceId(java.lang.String interfaceId)

setLevel

public void setLevel(int level)

setLiveInterfaceId

public void setLiveInterfaceId(java.lang.String newId)

setLineId

public void setLineId(int id)

setTemplate

public void setTemplate(java.lang.String template)

setType

public void setType(InterfaceDBO.Type type)

sanityCheck

public static void sanityCheck(java.lang.String interfaceId)
                        throws APIException
Throws:
APIException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

fromArray

public InterfaceDBO fromArray(java.lang.Object[] data)
                       throws APIException
Description copied from class: DBObject
Deserialize the database object's settings from a request array. This method is used to reconstruct a database object from the array that was created by DBObject.toArray().

Specified by:
fromArray in class DBObject
Parameters:
data - the object list that renders this object
Returns:
this object, for convenience
Throws:
APIException - if there is something wrong with the serialized data that interferes with the reconstruction of the object. The most obvious reason for this would be if the serialized array contains the wrong number of fields or otherwise does not match the serialized form for this type of database object.

toArray

public java.lang.Object[] toArray()
Description copied from class: DBObject
Serializes this database object as an array of objects. As specified in the description for Protocol, all supported protocols transfer database objects in this form.

Specified by:
toArray in class DBObject