com.buildforge.services.client.dbo
Class EnvironmentEntry

java.lang.Object
  extended by com.buildforge.services.client.dbo.EnvironmentEntry

public final class EnvironmentEntry
extends java.lang.Object

A single name/value pair that belongs to an Environment parent


Field Summary
static java.lang.Class<EnvironmentEntry> CLASS
           
 
Constructor Summary
EnvironmentEntry(APIClientConnection conn, Environment newParent)
          Define a new environment entry object.
 
Method Summary
 EnvironmentEntry clone()
           
 void delete()
          Removes this EnvironmentEntry from its parent Environment and from the database, if the parent Environment already exists in the database.
 EnvironmentEntryDBO.Action getAction()
          Returns the Action associated with this Environment Entry.
 int getEntryId()
          Returns this Entry's ordinal
 int getEnvGroupId()
          Returns this Entry's Environment Group Identifier
 EnvironmentEntryDBO.Mode getMode()
          Returns the Mode associated with this Environment Entry.
 java.lang.String getParameterName()
          Returns the parameter name of this Environment Entry
 java.lang.String getParameterValue()
          Returns the parameter value of this Environment Entry.
 Environment getParent()
          Returns a reference to this Entry's parent Environment
 void setAction(EnvironmentEntryDBO.Action action)
          Sets the associated Action for the Environment Entry.
 void setMode(EnvironmentEntryDBO.Mode mode)
          Sets the associated Mode for the Environment Entry.
 void setParameterName(java.lang.String parameterName)
          Sets the parameter name for this EnvironmentEntry.
 void setParameterValue(java.lang.String parameterValue)
          Sets the parameter value of this Environment Entry.
 java.lang.String toString()
           
 EnvironmentEntry update()
          Commits any changes to this EnvironmentEntry to the database
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS

public static final java.lang.Class<EnvironmentEntry> CLASS
Constructor Detail

EnvironmentEntry

public EnvironmentEntry(APIClientConnection conn,
                        Environment newParent)
Define a new environment entry object. The environment entry will not exist until after it has been created using the parent's create() method or until this EnvironmentEntry has been added to the already created parent.

Parameters:
conn - the services layer connection that the collector property should use when submitting requests
parent - the collector to which this property belongs
Method Detail

update

public EnvironmentEntry update()
                        throws java.io.IOException,
                               ServiceException
Commits any changes to this EnvironmentEntry to the database

Returns:
Throws:
java.io.IOException
ServiceException - If this EnvironmentEntry does not already exist in the database

delete

public void delete()
            throws java.io.IOException,
                   ServiceException
Removes this EnvironmentEntry from its parent Environment and from the database, if the parent Environment already exists in the database.

Throws:
java.io.IOException
ServiceException

getAction

public EnvironmentEntryDBO.Action getAction()
Returns the Action associated with this Environment Entry. See EnvironmentEntryDBO.Action for details


getEntryId

public int getEntryId()
Returns this Entry's ordinal


getEnvGroupId

public int getEnvGroupId()
Returns this Entry's Environment Group Identifier


getMode

public EnvironmentEntryDBO.Mode getMode()
Returns the Mode associated with this Environment Entry. See EnvironmentEntryDBO.Mode for details


getParameterName

public java.lang.String getParameterName()
Returns the parameter name of this Environment Entry


getParameterValue

public java.lang.String getParameterValue()
Returns the parameter value of this Environment Entry. For environment dot commands like .include and .regex, the arguments to the dot command go here.


getParent

public Environment getParent()
Returns a reference to this Entry's parent Environment


setAction

public void setAction(EnvironmentEntryDBO.Action action)
Sets the associated Action for the Environment Entry. See EnvironmentEntryDBO.Action for details

Parameters:
action -

setMode

public void setMode(EnvironmentEntryDBO.Mode mode)
Sets the associated Mode for the Environment Entry. See EnvironmentEntryDBO.Mode for details

Parameters:
mode -

setParameterName

public void setParameterName(java.lang.String parameterName)
Sets the parameter name for this EnvironmentEntry. For environment dot commands like .include and .regex, the dot command goes here.

Parameters:
parameterName -

setParameterValue

public void setParameterValue(java.lang.String parameterValue)
Sets the parameter value of this Environment Entry. For environment dot commands like .include and .regex, the arguments to the dot command go here.

Parameters:
parameterValue -

toString

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

clone

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