com.buildforge.services.common.dbo
Class ManifestPropertyDBO

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

public class ManifestPropertyDBO
extends DBObject

Database information representing a single value in the manifest data for a server.


Nested Class Summary
static class ManifestPropertyDBO.Category
          Identifies the kind of property that this is.
 
Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
ManifestPropertyDBO()
           
ManifestPropertyDBO(java.lang.String newManifestName, java.lang.String newName, java.lang.String newValue, ManifestPropertyDBO.Category newCategory)
           
 
Method Summary
 boolean equals(java.lang.Object other)
           
 ManifestPropertyDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 ManifestPropertyDBO.Category getPropertyCategory()
           
 java.lang.String getPropertyName()
           
 java.lang.String getPropertyValue()
           
 java.lang.String getServerName()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 int hashCode()
           
 boolean isLive()
          Checks whether or not the object is live.
 void setPropertyCategory(ManifestPropertyDBO.Category newPropertyCat)
           
 void setPropertyName(java.lang.String propertyName)
           
 void setPropertyValue(java.lang.String propertyValue)
           
 void setServerName(java.lang.String serverName)
           
 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
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_KEY

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

ManifestPropertyDBO

public ManifestPropertyDBO()

ManifestPropertyDBO

public ManifestPropertyDBO(java.lang.String newManifestName,
                           java.lang.String newName,
                           java.lang.String newValue,
                           ManifestPropertyDBO.Category newCategory)
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.

getServerName

public java.lang.String getServerName()

getPropertyName

public java.lang.String getPropertyName()

getPropertyValue

public java.lang.String getPropertyValue()

getPropertyCategory

public ManifestPropertyDBO.Category getPropertyCategory()

setServerName

public void setServerName(java.lang.String serverName)

setPropertyName

public void setPropertyName(java.lang.String propertyName)

setPropertyValue

public void setPropertyValue(java.lang.String propertyValue)

setPropertyCategory

public void setPropertyCategory(ManifestPropertyDBO.Category newPropertyCat)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

fromArray

public ManifestPropertyDBO 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

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class java.lang.Object

toString

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