|
|||||||||
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.EnvironmentDBO
public class EnvironmentDBO
Database information representing an environment group.
Field Summary | |
---|---|
static java.lang.String |
TYPE_KEY
|
Constructor Summary | |
---|---|
EnvironmentDBO()
|
Method Summary | |
---|---|
void |
addEntry(EnvironmentEntryDBO newEntry)
Adds a new Entry to the end of the list |
void |
addEntry(EnvironmentEntryDBO newEntry,
int index)
Adds a new Entry at the supplied, 0-based index |
EnvironmentDBO |
clone()
|
EnvironmentEntryDBO |
copyEntry(int index)
Returns a copy of the specified EnvironmentEntry. |
void |
copyEntry(int fromIndex,
int toIndex)
Copies the specified entry into a new position in the entry list |
EnvironmentDBO |
fromArray(java.lang.Object[] data)
Deserialize the database object's settings from a request array. |
java.util.List<EnvironmentEntryDBO> |
getEntries()
|
EnvironmentEntryDBO |
getEntry(java.lang.String parameterName)
|
int |
getEnvGroupId()
|
int |
getLevel()
|
java.lang.String |
getName()
|
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. |
void |
moveEntry(int fromIndex,
int toIndex)
Moves a property from one 0-based index to another. |
EnvironmentEntryDBO |
removeEntry(EnvironmentEntryDBO entry)
Removes an Entry |
EnvironmentEntryDBO |
removeEntry(int index)
Removes an Entry by 0-based index |
EnvironmentEntryDBO |
removeEntry(java.lang.String parameterName)
Removes an Entry by name |
void |
setEntries(java.util.List<EnvironmentEntryDBO> newEntryList)
|
void |
setEnvGroupId(int newEnvGroupId)
|
void |
setLevel(int level)
|
void |
setName(java.lang.String name)
|
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 |
---|
public static final java.lang.String TYPE_KEY
Constructor Detail |
---|
public EnvironmentDBO()
Method Detail |
---|
public java.lang.String getTypeKey()
DBObject
getTypeKey
in class DBObject
public boolean isLive()
DBObject
isLive
in class DBObject
public int getEnvGroupId()
public int getLevel()
public java.lang.String getName()
public java.util.List<EnvironmentEntryDBO> getEntries()
public EnvironmentEntryDBO getEntry(java.lang.String parameterName)
public void setEnvGroupId(int newEnvGroupId)
public void setLevel(int level)
public void setName(java.lang.String name)
public void setEntries(java.util.List<EnvironmentEntryDBO> newEntryList)
public void addEntry(EnvironmentEntryDBO newEntry)
newEntry
- public void addEntry(EnvironmentEntryDBO newEntry, int index) throws APIException
newEntry
- index
- The 0-based index to insert the new Entry
APIException
public EnvironmentEntryDBO removeEntry(int index)
index
- public EnvironmentEntryDBO removeEntry(java.lang.String parameterName)
parameterName
-
public EnvironmentEntryDBO removeEntry(EnvironmentEntryDBO entry)
parameterName
-
public void moveEntry(int fromIndex, int toIndex) throws APIException
fromIndex
- toIndex
-
APIException
public EnvironmentEntryDBO copyEntry(int index) throws APIException
index
- The 0-based index to specify the property to copy
APIException
public void copyEntry(int fromIndex, int toIndex) throws APIException
fromIndex
- toIndex
-
APIException
public java.lang.String toString()
toString
in class java.lang.Object
public EnvironmentDBO 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 EnvironmentDBO clone()
clone
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |