|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.common.dbo.DBObject
com.buildforge.services.common.dbo.EnvironmentEntryDBO
public class EnvironmentEntryDBO
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 |
---|
public static final java.lang.String TYPE_KEY
Constructor Detail |
---|
public EnvironmentEntryDBO()
public EnvironmentEntryDBO(int newEnvironmentId, int newEntryId, java.lang.String newParameterName, java.lang.String newParameterValue, EnvironmentEntryDBO.Action newAction, EnvironmentEntryDBO.Mode newMode)
Method Detail |
---|
public java.lang.String getTypeKey()
DBObject
getTypeKey
in class DBObject
public boolean isLive()
DBObject
isLive
in class DBObject
public EnvironmentEntryDBO.Action getAction()
public int getEntryId()
public int getEnvGroupId()
public EnvironmentEntryDBO.Mode getMode()
public java.lang.String getParameterName()
public java.lang.String getParameterValue()
public void setAction(EnvironmentEntryDBO.Action action)
public void setEntryId(int envEntryId)
public void setEnvGroupId(int envGroupId)
public void setMode(EnvironmentEntryDBO.Mode mode)
public void setParameterName(java.lang.String parameterName)
public void setParameterValue(java.lang.String parameterValue)
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public EnvironmentEntryDBO fromArray(java.lang.Object[] data) throws APIException
DBObject
DBObject.toArray()
.
fromArray
in class DBObject
data
- the object list that renders this object
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.public java.lang.Object[] toArray()
DBObject
Protocol
, all supported
protocols transfer database objects in this form.
toArray
in class DBObject
public static void sanityCheckGroupId(int groupId) throws APIException
APIException
public static void sanityCheckEntryId(int entryId) throws APIException
APIException
public java.lang.String toString()
toString
in class java.lang.Object
public EnvironmentEntryDBO clone()
clone
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |