com.buildforge.services.common.dbo
Class EnvironmentDBO

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

public class EnvironmentDBO
extends DBObject

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

TYPE_KEY

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

EnvironmentDBO

public EnvironmentDBO()
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.

getEnvGroupId

public int getEnvGroupId()

getLevel

public int getLevel()

getName

public java.lang.String getName()

getEntries

public java.util.List<EnvironmentEntryDBO> getEntries()

getEntry

public EnvironmentEntryDBO getEntry(java.lang.String parameterName)

setEnvGroupId

public void setEnvGroupId(int newEnvGroupId)

setLevel

public void setLevel(int level)

setName

public void setName(java.lang.String name)

setEntries

public void setEntries(java.util.List<EnvironmentEntryDBO> newEntryList)

addEntry

public void addEntry(EnvironmentEntryDBO newEntry)
Adds a new Entry to the end of the list

Parameters:
newEntry -

addEntry

public void addEntry(EnvironmentEntryDBO newEntry,
                     int index)
              throws APIException
Adds a new Entry at the supplied, 0-based index

Parameters:
newEntry -
index - The 0-based index to insert the new Entry
Throws:
APIException

removeEntry

public EnvironmentEntryDBO removeEntry(int index)
Removes an Entry by 0-based index

Parameters:
index -

removeEntry

public EnvironmentEntryDBO removeEntry(java.lang.String parameterName)
Removes an Entry by name

Parameters:
parameterName -
Returns:
the removed entry

removeEntry

public EnvironmentEntryDBO removeEntry(EnvironmentEntryDBO entry)
Removes an Entry

Parameters:
parameterName -
Returns:
the removed entry

moveEntry

public void moveEntry(int fromIndex,
                      int toIndex)
               throws APIException
Moves a property from one 0-based index to another.

Parameters:
fromIndex -
toIndex -
Throws:
APIException

copyEntry

public EnvironmentEntryDBO copyEntry(int index)
                              throws APIException
Returns a copy of the specified EnvironmentEntry. This copy is in no way connected to the original, and will be suitable for addition to another, entirely different Environment.

Parameters:
index - The 0-based index to specify the property to copy
Returns:
the copied entry
Throws:
APIException

copyEntry

public void copyEntry(int fromIndex,
                      int toIndex)
               throws APIException
Copies the specified entry into a new position in the entry list

Parameters:
fromIndex -
toIndex -
Throws:
APIException

toString

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

fromArray

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

clone

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