com.buildforge.services.client.dbo
Class TimeZone

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

public class TimeZone
extends java.lang.Object

Represents a specific time zone, generally used to assign to Users.


Field Summary
static java.lang.Class<TimeZone> CLASS
           
 
Constructor Summary
TimeZone(APIClientConnection conn)
          Defines a new TimeZone
 
Method Summary
 TimeZone create()
          Deprecated.  
 void delete()
          Deprecated.  
static void deleteById(APIClientConnection conn, java.lang.String zoneId)
          Deprecated.  
static java.util.List<TimeZone> findAll(APIClientConnection conn)
          Retrieves all TimeZone objects from the database
static TimeZone findById(APIClientConnection conn, java.lang.String zoneId)
          Retrieves a specific TimeZone by identifier
 java.lang.String getDescription()
          Returns the friendly description of this TimeZone
 int getDstEndDay()
          Returns the day daylight savings time (DST) ends in this TimeZone: -1 None - DST does not apply to this timezone 0 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday
 int getDstEndMon()
          Returns the month daylight savings time (DST) ends in this TimeZone -1 None - DST does not apply to this timezone 0 January 1 Februrary 2 March 3 April 4 May 5 June 6 July 7 August 8 September 9 October 10 November 11 December
 int getDstEndPos()
          Returns the ordinal of the day in the month (first monday, second tuesday, last wednesday, etc.) that daylight savings time (DST) ends in this TimeZone 0 None - DST does not apply to this timezone 1 First 2 Second 3 Third 4 Fourth 5 Fifth - I can't imagine that this would ever be useful, but ok...
 int getDstOffset()
          Returns the additional adjustment, in seconds, that is added to adjusted times while DST is active.
 int getDstStartDay()
          Returns the day daylight savings time (DST) begins in this TimeZone - see getDstEndDay() for value table
 int getDstStartMon()
          Returns the month daylight savings time (DST) begins in this TimeZone - see getDstEndMon() for value table
 int getDstStartPos()
          Returns the ordinal of the day in the month (first monday, second tuesday, last wednesday, etc.) that daylight savings time (DST) ends in this TimeZone - see getDstEndPos() for value table
 int getGmtOffset()
          Returns the base amount of time, in seconds, by which to adjust the UTC time to convert it to this time zone, assuming DST is not active.
 java.lang.String getZoneId()
          Returns the unique identifier of this TimeZone
 void setDescription(java.lang.String description)
          Sets the friendly description of this TimeZone
 void setDstEndDay(int dstEndDay)
          Sets the day DST ends in this TimeZone - see getDstEndDay() for value table
 void setDstEndMon(int dstEndMon)
          Sets the month DST ends in this TimeZone - see getDstEndMon() for value table
 void setDstEndPos(int dstEndPos)
          Sets the ordinal of the day in the month (first monday, second tuesday, last wednesday, etc.) that daylight savings time (DST) ends in this TimeZone - see getDstEndPos() for value table
 void setDstOffset(int dstOffset)
          Sets the additional adjustment, in seconds, that is added to adjusted times while DST is active.
 void setDstStartDay(int dstStartDay)
          Sets the day daylight savings time (DST) begins in this TimeZone - see getDstEndDay() for value table
 void setDstStartMon(int dstStartMon)
          Sets the month daylight savings time (DST) begins in this TimeZone - see getDstEndMon() for value table
 void setDstStartPos(int dstStartPos)
          Sets the ordinal of the day in the month (first monday, second tuesday, last wednesday, etc.) that daylight savings time (DST) ends in this TimeZone - see getDstEndPos() for value table
 void setGmtOffset(int gmtOffset)
          Sets the base amount of time, in seconds, by which to adjust the UTC time to convert it to this time zone, assuming DST is not active.
 void setZoneId(java.lang.String newZoneId)
          Sets the unique identifier of this TimeZone
 java.lang.String toString()
           
 TimeZone update()
          Deprecated.  
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS

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

TimeZone

public TimeZone(APIClientConnection conn)
Defines a new TimeZone

Parameters:
conn -
Method Detail

findAll

public static java.util.List<TimeZone> findAll(APIClientConnection conn)
                                        throws java.io.IOException,
                                               ServiceException
Retrieves all TimeZone objects from the database

Parameters:
conn -
Returns:
Throws:
java.io.IOException
ServiceException

findById

public static TimeZone findById(APIClientConnection conn,
                                java.lang.String zoneId)
                         throws java.io.IOException,
                                ServiceException
Retrieves a specific TimeZone by identifier

Parameters:
conn -
zoneId -
Returns:
Throws:
java.io.IOException
ServiceException

create

public TimeZone create()
                throws java.io.IOException,
                       ServiceException
Deprecated. 

Creates this new TimeZone in the database

Returns:
Throws:
java.io.IOException
ServiceException

update

public TimeZone update()
                throws java.io.IOException,
                       ServiceException
Deprecated. 

Commits the current state of this TimeZone object to the database

Returns:
Throws:
java.io.IOException
ServiceException

delete

public void delete()
            throws java.io.IOException,
                   ServiceException
Deprecated. 

Removes this TimeZone from the database

Throws:
java.io.IOException
ServiceException

deleteById

public static void deleteById(APIClientConnection conn,
                              java.lang.String zoneId)
                       throws java.io.IOException,
                              ServiceException
Deprecated. 

Deletes the specified TimeZone from the database

Parameters:
conn -
zoneId -
Throws:
java.io.IOException
ServiceException

getZoneId

public java.lang.String getZoneId()
Returns the unique identifier of this TimeZone


getDescription

public java.lang.String getDescription()
Returns the friendly description of this TimeZone


getDstEndDay

public int getDstEndDay()
Returns the day daylight savings time (DST) ends in this TimeZone: -1 None - DST does not apply to this timezone 0 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday


getDstEndMon

public int getDstEndMon()
Returns the month daylight savings time (DST) ends in this TimeZone -1 None - DST does not apply to this timezone 0 January 1 Februrary 2 March 3 April 4 May 5 June 6 July 7 August 8 September 9 October 10 November 11 December


getDstEndPos

public int getDstEndPos()
Returns the ordinal of the day in the month (first monday, second tuesday, last wednesday, etc.) that daylight savings time (DST) ends in this TimeZone 0 None - DST does not apply to this timezone 1 First 2 Second 3 Third 4 Fourth 5 Fifth - I can't imagine that this would ever be useful, but ok... 6 Last


getDstOffset

public int getDstOffset()
Returns the additional adjustment, in seconds, that is added to adjusted times while DST is active.


getDstStartDay

public int getDstStartDay()
Returns the day daylight savings time (DST) begins in this TimeZone - see getDstEndDay() for value table

See Also:
getDstEndDay()

getDstStartMon

public int getDstStartMon()
Returns the month daylight savings time (DST) begins in this TimeZone - see getDstEndMon() for value table

See Also:
getDstEndMon()

getDstStartPos

public int getDstStartPos()
Returns the ordinal of the day in the month (first monday, second tuesday, last wednesday, etc.) that daylight savings time (DST) ends in this TimeZone - see getDstEndPos() for value table

See Also:
getDstEndPos()

getGmtOffset

public int getGmtOffset()
Returns the base amount of time, in seconds, by which to adjust the UTC time to convert it to this time zone, assuming DST is not active.


setZoneId

public void setZoneId(java.lang.String newZoneId)
Sets the unique identifier of this TimeZone

Parameters:
newZoneId -

setDescription

public void setDescription(java.lang.String description)
Sets the friendly description of this TimeZone

Parameters:
description -

setDstEndDay

public void setDstEndDay(int dstEndDay)
Sets the day DST ends in this TimeZone - see getDstEndDay() for value table

Parameters:
dstEndDay -
See Also:
getDstEndDay()

setDstEndMon

public void setDstEndMon(int dstEndMon)
Sets the month DST ends in this TimeZone - see getDstEndMon() for value table

Parameters:
dstEndMon -
See Also:
getDstEndMon()

setDstEndPos

public void setDstEndPos(int dstEndPos)
Sets the ordinal of the day in the month (first monday, second tuesday, last wednesday, etc.) that daylight savings time (DST) ends in this TimeZone - see getDstEndPos() for value table

Parameters:
dstEndPos -
See Also:
getDstEndPos()

setDstOffset

public void setDstOffset(int dstOffset)
Sets the additional adjustment, in seconds, that is added to adjusted times while DST is active.

Parameters:
dstOffset -

setDstStartDay

public void setDstStartDay(int dstStartDay)
Sets the day daylight savings time (DST) begins in this TimeZone - see getDstEndDay() for value table

Parameters:
dstStartDay -
See Also:
getDstEndDay()

setDstStartMon

public void setDstStartMon(int dstStartMon)
Sets the month daylight savings time (DST) begins in this TimeZone - see getDstEndMon() for value table

Parameters:
dstStartMon -
See Also:
getDstEndMon()

setDstStartPos

public void setDstStartPos(int dstStartPos)
Sets the ordinal of the day in the month (first monday, second tuesday, last wednesday, etc.) that daylight savings time (DST) ends in this TimeZone - see getDstEndPos() for value table

Parameters:
dstStartPos -
See Also:
getDstEndPos()

setGmtOffset

public void setGmtOffset(int gmtOffset)
Sets the base amount of time, in seconds, by which to adjust the UTC time to convert it to this time zone, assuming DST is not active.


toString

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