oracle.calendar.soap.iCal
Class vCalendar

java.lang.Object
  |
  +--oracle.calendar.soap.iCal.vCalendar

public class vCalendar

extends java.lang.Object

The vCalendar object is a container for all related vEvents and vTasks (although not required by the IETF iCalendar specification).

See Also:

iCalendar, vEvent, vTodo, vTimezone

Field Summary

(package private) static java.lang.String	k_CalScale
(package private) static java.lang.String	k_defaultProdID
(package private) static java.lang.String	k_defaultVersion
(package private) static java.lang.String	k_Language
(package private) static java.lang.String	k_ProdID
(package private) static java.lang.String	k_timezone
(package private) static java.lang.String	k_vCalendar
(package private) static java.lang.String	k_Version
(package private) static java.lang.String	k_vEvent
(package private) static java.lang.String	k_vTodo
private java.lang.String	m_calscale
private java.util.Vector	m_components
private java.lang.String	m_language
private java.lang.String	m_prodId
private java.lang.String	m_version

Constructor Summary

vCalendar()
Default constructor

Method Summary

void	addvComponent(vComponent in_vComponent) Adds a new vComponent (vTodo or vEvent) to the vCalendar list
java.lang.String	getCalScale() Pretty useless.
java.util.Vector	getComponents() Returns a Vector of vEvents or vTodos.
org.w3c.dom.Element	getElement(org.w3c.dom.Document in_document) Returns a new XML DOM structure representing the vCalendar XML tree structure.
java.lang.String	getLanguage() The language used within the vCalendar.
java.lang.String	getProdId() Retrieves the product ID of the originating calendar store
void	getProdId(java.lang.String in_prodId) Assigns a new product ID for the vCalendar
java.lang.String	getVersion() Retrieves the version of the iCalendar, typically 2.0
java.lang.String	toString() Constructs a String representing the vCalendar objects and all children.
static vCalendar	unmarshall(org.w3c.dom.Element in_element) Constructs a new vCalendar instance from the XML elements within the XML DOM.

Methods inherited from class java.lang.Object

<clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait

Field Detail

k_Version

static final java.lang.String k_Version

k_ProdID

static final java.lang.String k_ProdID

k_CalScale

static final java.lang.String k_CalScale

k_Language

static final java.lang.String k_Language

k_vCalendar

static final java.lang.String k_vCalendar

k_vEvent

static final java.lang.String k_vEvent

k_timezone

static final java.lang.String k_timezone

k_vTodo

static final java.lang.String k_vTodo

k_defaultProdID

static final java.lang.String k_defaultProdID

k_defaultVersion

static final java.lang.String k_defaultVersion

m_version

private java.lang.String m_version

m_prodId

private java.lang.String m_prodId

m_calscale

private java.lang.String m_calscale

m_language

private java.lang.String m_language

m_components

private java.util.Vector m_components

Constructor Detail

vCalendar

public vCalendar()

Default constructor

Method Detail

getVersion

public java.lang.String getVersion()

Retrieves the version of the iCalendar, typically 2.0

Returns:

String the iCalendar version

getProdId

public java.lang.String getProdId()

Retrieves the product ID of the originating calendar store

Returns:

String the iCalendar product ID

getProdId

public void getProdId(java.lang.String in_prodId)

Assigns a new product ID for the vCalendar

Parameters:

String - the iCalendar product ID

getCalScale

public java.lang.String getCalScale()

Pretty useless. Don't look at it. Not supported.

Returns:

String don't bother, not supported

getLanguage

public java.lang.String getLanguage()

The language used within the vCalendar. This isn't not supported.

Returns:

String don't bother, not supported

getComponents

public java.util.Vector getComponents()

Returns a Vector of vEvents or vTodos.

Returns:

Vector a vector of events or tasks

addvComponent

public void addvComponent(vComponent in_vComponent)

Adds a new vComponent (vTodo or vEvent) to the vCalendar list

Parameters:

in_vComponent - a child component

unmarshall

public static vCalendar unmarshall(org.w3c.dom.Element in_element)

Constructs a new vCalendar instance from the XML elements within the XML DOM. The vCalendar will contain the contents of the all vEvent, vTodo, vTimezeon objects within the tree.

Parameters:

in_element -

Returns:

vCalendar a vCalendar object

getElement

public org.w3c.dom.Element getElement(org.w3c.dom.Document in_document)

Returns a new XML DOM structure representing the vCalendar XML tree structure. This is called internally when a Calendarlet command is being generated to DOM format.

Returns:

Element an XML DOM element tree

toString

public java.lang.String toString()

Constructs a String representing the vCalendar objects and all children. NOTE: this is not iCalendar 2.0 format.

Overrides:

toString in class java.lang.Object

Returns:

String a serialized vCal