Overview

/** Interface representing a snapshot of a time zone entity. OCS Time Zone Service will rely on the time zone definitions provided by the public domain "TZ Database[TZDB]" maintained at the National Institute of Health (NIH) by Arthur David Olson. The "TZ Database" is the most up to date and reliable source of information for time zone information. The database can be access at this link.

A time zone is a geographical region within which the same local time is used.

  • TimeZoneRule: A TimeZone node defines all the rules that defines the transition between standard time and daylight saving time and vice versa. A time zone have at least one time zone rule.
  • Name: The Name attribute of TimeZone entity will be set to the TZ Database timezone identifier (e.g., America/Los_Angeles).
  • CountryCode: The CountryCode attribute specifies the upper-case, two-letter country code as defined by [ISO-3166]
  • Aliases: The TimeZone node defines the aliases used for this particular time zone in different namespaces (e.g., for time zone "America/NewYork", its alias name is "America/NewYork" in the TZDB namespace, "Eastern Standard Time" in Microsoft Windows [MSFT] namespace). A TimeZone may have only one alias per namespace.
  • Coordinates: Defines the longitude and latitude of this time zone.

The following attributes are part of the BASIC projection: CollabId, Name, ModifiedOn, TimeZone Rules.

There are also some methods provided by this interface.

  • getHandle() It will return a TimeZoneHandle, which is a pointer to the underlying TimeZone object. The load() operation of the handle will return this TimeZone object to which the handle referred.
  • getTimeZoneRule(Date) Given a UTC date time, it will return the TimeZoneRule that takes effect on this given date.
  • getUTCOffsetRaw(Date) Given a UTC date time, it will return the UTCOffsetRaw for the given date in this time zone.

Members

Show inherited members

Projections
Name Type Required Description

aliases

timeZoneAlias[]
Returns the aliases of this time zone.

attachedMarkers

marker[]
Set of marker elements associated with the entity.

attachedReminders

reminder[]
List of reminders attached to the entity

attachedSubscriptions

subscription[]
List of subscriptions attached to the entity

bonds

bond[]
The Bonds of the TimeZone

collabId

beeId
CollabId of the snapshot

common

boolean
Returns common attribute of this time zone.

coordinates

coordinates
Returns coordinates of this time zone.

countryCode

string
Returns the ISO-3166 country code of this time zone.

createdOn

dateTime
Entity's creation date

creator

actor
The actor that created this entity

defaultCommon

boolean
Internal procedure only. Not expose in interface

deleted

boolean
Deletion flag. If this property is set to true the entity is deleted.

modifiedBy

actor
The actor that last modified the entity

modifiedOn

dateTime
The date when entity was last modified

name

string
Name of the entity.

parent

entity
The parent for this entity.

rules

timeZoneRule[]
Returns the transition rules of this time zone.

snapshotId

string
Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.

Hierarchy

Inherits From

Examples

Below are examples in XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:timeZone xsi:type="obh:timeZone" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <aliases>your_timeZoneAlias_0</aliases>
        <aliases>your_timeZoneAlias_1</aliases>
        <aliases>your_timeZoneAlias_2</aliases>
         <attachedMarkers>your_marker_0</attachedMarkers>
        <attachedMarkers>your_marker_1</attachedMarkers>
        <attachedMarkers>your_marker_2</attachedMarkers>
         <attachedReminders>your_reminder_0</attachedReminders>
        <attachedReminders>your_reminder_1</attachedReminders>
        <attachedReminders>your_reminder_2</attachedReminders>
         <attachedSubscriptions>your_subscription_0</attachedSubscriptions>
        <attachedSubscriptions>your_subscription_1</attachedSubscriptions>
        <attachedSubscriptions>your_subscription_2</attachedSubscriptions>
         <bonds>your_bond_0</bonds>
        <bonds>your_bond_1</bonds>
        <bonds>your_bond_2</bonds>
         <collabId>your_beeId_0</collabId>
         <common>your_boolean_0</common>
         <coordinates>your_coordinates_0</coordinates>
         <countryCode>your_string_0</countryCode>
         <createdOn>your_dateTime_0</createdOn>
         <creator>your_actor_0</creator>
         <defaultCommon>your_boolean_0</defaultCommon>
         <deleted>your_boolean_0</deleted>
         <modifiedBy>your_actor_0</modifiedBy>
         <modifiedOn>your_dateTime_0</modifiedOn>
         <name>your_string_0</name>
         <parent>your_entity_0</parent>
         <rules>your_timeZoneRule_0</rules>
        <rules>your_timeZoneRule_1</rules>
        <rules>your_timeZoneRule_2</rules>
         <snapshotId>your_string_0</snapshotId>
 </obh:timeZone>

Referenced By Representaions