com.buildforge.services.common.dbo
Class EnvironmentEntryDBO

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

public class EnvironmentEntryDBO
extends DBObject

Database object representing a single entry within an environment group.


Nested Class Summary
static class EnvironmentEntryDBO.Action
          Identifies what action is taken when an environment entry is applied.
static class EnvironmentEntryDBO.Mode
          Identifies special treatment of the variable regarding its display in the UI and whether or not its value may be changed.
 
Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
EnvironmentEntryDBO()
           
EnvironmentEntryDBO(int newEnvironmentId, int newEntryId, java.lang.String newParameterName, java.lang.String newParameterValue, EnvironmentEntryDBO.Action newAction, EnvironmentEntryDBO.Mode newMode)
           
 
Method Summary
 EnvironmentEntryDBO clone()
           
 boolean equals(java.lang.Object o)
           
 EnvironmentEntryDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 EnvironmentEntryDBO.Action getAction()
           
 int getEntryId()
           
 int getEnvGroupId()
           
 EnvironmentEntryDBO.Mode getMode()
           
 java.lang.String getParameterName()
           
 java.lang.String getParameterValue()
           
 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.
static void sanityCheckEntryId(int entryId)
           
static void sanityCheckGroupId(int groupId)
           
 void setAction(EnvironmentEntryDBO.Action action)
           
 void setEntryId(int envEntryId)
           
 void setEnvGroupId(int envGroupId)
           
 void setMode(EnvironmentEntryDBO.Mode mode)
           
 void setParameterName(java.lang.String parameterName)
           
 void setParameterValue(java.lang.String parameterValue)
           
 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

EnvironmentEntryDBO

public EnvironmentEntryDBO()

EnvironmentEntryDBO

public EnvironmentEntryDBO(int newEnvironmentId,
                           int newEntryId,
                           java.lang.String newParameterName,
                           java.lang.String newParameterValue,
                           EnvironmentEntryDBO.Action newAction,
                           EnvironmentEntryDBO.Mode newMode)
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.

getAction

public EnvironmentEntryDBO.Action getAction()

getEntryId

public int getEntryId()

getEnvGroupId

public int getEnvGroupId()

getMode

public EnvironmentEntryDBO.Mode getMode()

getParameterName

public java.lang.String getParameterName()

getParameterValue

public java.lang.String getParameterValue()

setAction

public void setAction(EnvironmentEntryDBO.Action action)

setEntryId

public void setEntryId(int envEntryId)

setEnvGroupId

public void setEnvGroupId(int envGroupId)

setMode

public void setMode(EnvironmentEntryDBO.Mode mode)

setParameterName

public void setParameterName(java.lang.String parameterName)

setParameterValue

public void setParameterValue(java.lang.String parameterValue)

equals

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

hashCode

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

fromArray

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

sanityCheckGroupId

public static void sanityCheckGroupId(int groupId)
                               throws APIException
Throws:
APIException

sanityCheckEntryId

public static void sanityCheckEntryId(int entryId)
                               throws APIException
Throws:
APIException

toString

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

clone

public EnvironmentEntryDBO clone()
Overrides:
clone in class java.lang.Object