com.buildforge.services.common.dbo
Class TimeZoneDBO

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

public class TimeZoneDBO
extends DBObject

Database information representing the settings for a time zone.


Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
TimeZoneDBO()
           
 
Method Summary
 TimeZoneDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 java.lang.String getDescription()
           
 int getDstEndDay()
           
 int getDstEndMon()
           
 int getDstEndPos()
           
 int getDstOffset()
           
 int getDstStartDay()
           
 int getDstStartMon()
           
 int getDstStartPos()
           
 int getGmtOffset()
           
 java.lang.String getLiveZoneId()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 java.lang.String getZoneId()
           
 boolean isLive()
          Checks whether or not the object is live.
static void sanityCheck(TimeZoneDBO zone)
           
 void setDescription(java.lang.String description)
           
 void setDstEndDay(int dstEndDay)
           
 void setDstEndMon(int dstEndMon)
           
 void setDstEndPos(int dstEndPos)
           
 void setDstOffset(int dstOffset)
           
 void setDstStartDay(int dstStartDay)
           
 void setDstStartMon(int dstStartMon)
           
 void setDstStartPos(int dstStartPos)
           
 void setGmtOffset(int gmtOffset)
           
 void setLiveZoneId(java.lang.String liveZoneId)
           
 void setZoneId(java.lang.String zoneId)
           
 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

TimeZoneDBO

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

getDescription

public java.lang.String getDescription()

getDstEndDay

public int getDstEndDay()

getDstEndMon

public int getDstEndMon()

getDstEndPos

public int getDstEndPos()

getDstOffset

public int getDstOffset()

getDstStartDay

public int getDstStartDay()

getDstStartMon

public int getDstStartMon()

getDstStartPos

public int getDstStartPos()

getGmtOffset

public int getGmtOffset()

getZoneId

public java.lang.String getZoneId()

getLiveZoneId

public java.lang.String getLiveZoneId()

setDescription

public void setDescription(java.lang.String description)

setDstEndDay

public void setDstEndDay(int dstEndDay)

setDstEndMon

public void setDstEndMon(int dstEndMon)

setDstEndPos

public void setDstEndPos(int dstEndPos)

setDstOffset

public void setDstOffset(int dstOffset)

setDstStartDay

public void setDstStartDay(int dstStartDay)

setDstStartMon

public void setDstStartMon(int dstStartMon)

setDstStartPos

public void setDstStartPos(int dstStartPos)

setGmtOffset

public void setGmtOffset(int gmtOffset)

setZoneId

public void setZoneId(java.lang.String zoneId)

setLiveZoneId

public void setLiveZoneId(java.lang.String liveZoneId)

sanityCheck

public static void sanityCheck(TimeZoneDBO zone)
                        throws APIException
Throws:
APIException

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 TimeZoneDBO 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.