oracle.calendar.soap.iCal
Class vCalendar

java.lang.Object
oracle.calendar.soap.iCal.vCalendar

public class vCalendar

extends java.lang.Object

Container for all related vEvents and vTasks (although some are not required by the IETF iCalendar specification).

See Also:

iCalendar, vEvent, vTodo, vTimezone

Constructor Summary

vCalendar()
Default constructor.

Method Summary

void	addvComponent(vComponent in_vComponent) Adds a new vComponent (vTodo or vEvent) to the vCalendar object.
java.lang.String	getCalScale() Not supported; returns the calendar scale used, such as the Gregorian calendar scale.
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() Not supported; returns the language used by 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 non-XML String representing the vCalendar object and all its 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

vCalendar

public vCalendar()

Default constructor. version 2002-12-19 fix008364

Method Detail

getVersion

public java.lang.String getVersion()

Retrieves the version of the iCalendar, typically 2.0. version 2002-12-16 fix008343

Returns:

String the iCalendar version

getProdId

public java.lang.String getProdId()

Retrieves the product ID of the originating Calendar store. version 2002-12-16 fix008343

Returns:

String the iCalendar product ID

getProdId

public void getProdId(java.lang.String in_prodId)

Assigns a new product ID for the vCalendar. version 2002-12-19 fix008364

Parameters:

in_prodId - the iCalendar product ID

getCalScale

public java.lang.String getCalScale()

Not supported; returns the calendar scale used, such as the Gregorian calendar scale. This method is currently not supported; it returns a null value. version 2002-12-16 fix008343

Returns:

String - Null value

getLanguage

public java.lang.String getLanguage()

Not supported; returns the language used by vCalendar. This method is currently not supported; it returns a null value. version 2002-12-16 fix008343

Returns:

String - Null value

getComponents

public java.util.Vector getComponents()

Returns a Vector of vEvents or vTodos. version 2002-12-16 fix008343

Returns:

Vector - Vector of events or tasks

addvComponent

public void addvComponent(vComponent in_vComponent)

Adds a new vComponent (vTodo or vEvent) to the vCalendar object. version 2002-12-19 fix008364

Parameters:

in_vComponent - - vTodo or vEvent 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, and vTimezeone objects within the tree. version 2003-05-19 fix009239

Parameters:

in_element - XML DOM representing a vCalendar instance

Returns:

vCalendar - 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 generated to DOM format. version 2004-04-24 fix009031

Returns:

Element - XML DOM element tree

toString

public java.lang.String toString()

Constructs a non-XML String representing the vCalendar object and all its children. (In general, each line of this string contains an iCalendar property, followed by a colon, then the value of the property.) Note that this string is not IETF iCalendar 2.0 format. version 2003-01-16 fix008443

Returns:

String a serialized vCal