com.buildforge.services.common.dbo
Class TemplateDBO

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

public class TemplateDBO
extends DBObject

Database information representing an e-mail template definition. E-mail templates may be scoped to exist system-wide, only within a specific project, or only within a specific step of a specific project. Templates are used by the engine to report certain conditions during the running of a project. The template is located using a specific name that the engine requests.


Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
TemplateDBO()
           
 
Method Summary
 TemplateDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 java.lang.String getBodyKey()
           
 java.lang.String getBodyText()
           
 java.lang.String getDescription()
           
 java.lang.String getFrom()
           
 java.lang.String getLiveLocale()
           
 java.lang.String getLiveName()
           
 int getLiveProjectId()
           
 int getLiveStepId()
           
 java.lang.String getLocale()
           
 java.lang.String getName()
           
 int getProjectId()
           
 int getStepId()
           
 java.lang.String getSubject()
           
 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 setBodyKey(java.lang.String bodyKey)
           
 void setBodyText(java.lang.String bodyText)
           
 void setDescription(java.lang.String description)
           
 void setFrom(java.lang.String from)
           
 void setLiveLocale(java.lang.String newLiveLocale)
           
 void setLiveName(java.lang.String newLiveName)
           
 void setLiveProjectId(int newLiveProjectId)
           
 void setLiveStepId(int newLiveStepId)
           
 void setLocale(java.lang.String newLocale)
           
 void setName(java.lang.String name)
           
 void setProjectId(int projectId)
           
 void setStepId(int stepId)
           
 void setSubject(java.lang.String subject)
           
 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

TemplateDBO

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

getBodyKey

public java.lang.String getBodyKey()

getBodyText

public java.lang.String getBodyText()

getDescription

public java.lang.String getDescription()

getFrom

public java.lang.String getFrom()

getLocale

public java.lang.String getLocale()

getName

public java.lang.String getName()

getProjectId

public int getProjectId()

getStepId

public int getStepId()

getSubject

public java.lang.String getSubject()

setBodyKey

public void setBodyKey(java.lang.String bodyKey)

setBodyText

public void setBodyText(java.lang.String bodyText)

setDescription

public void setDescription(java.lang.String description)

setFrom

public void setFrom(java.lang.String from)

setLocale

public void setLocale(java.lang.String newLocale)

setName

public void setName(java.lang.String name)

setProjectId

public void setProjectId(int projectId)

setStepId

public void setStepId(int stepId)

setSubject

public void setSubject(java.lang.String subject)

getLiveLocale

public java.lang.String getLiveLocale()

getLiveName

public java.lang.String getLiveName()

getLiveProjectId

public int getLiveProjectId()

getLiveStepId

public int getLiveStepId()

setLiveLocale

public void setLiveLocale(java.lang.String newLiveLocale)

setLiveName

public void setLiveName(java.lang.String newLiveName)

setLiveProjectId

public void setLiveProjectId(int newLiveProjectId)

setLiveStepId

public void setLiveStepId(int newLiveStepId)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.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

fromArray

public TemplateDBO 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.