oracle.calendar.soap.iCal
Class vTodo

java.lang.Object
oracle.calendar.soap.iCal.vComponent
oracle.calendar.soap.iCal.vTodo

public class vTodo

extends vComponent

Contains information about a task. This task, for this Web services implementation, cannot have attendees or be recurring; these features are not supported on the Calendar store.

Field Summary

static java.lang.String	k_completed
static java.lang.String	k_created
static java.lang.String	k_dataGuid
static java.lang.String	k_description
static java.lang.String	k_dtstamp
static java.lang.String	k_dtstart
static java.lang.String	k_due
static java.lang.String	k_lastModified
static java.lang.String	k_percent
static java.lang.String	k_priority
static java.lang.String	k_summary
static java.lang.String	k_taskClass
static java.lang.String	k_taskClassConfidential
static java.lang.String	k_taskClassPrivate
static java.lang.String	k_taskClassPublic
static java.lang.String	k_taskId
static java.lang.String	k_uid
static java.lang.String	k_value
static java.lang.String	k_valueTypeDate
static java.lang.String	k_valueTypeDateTime
static java.lang.String	k_vTodo

Constructor Summary

vTodo()
Default constructor version 2002-12-16 fix008343

Method Summary

java.lang.String	getCompleted() Retrieves the task completed status.
java.lang.String	getCreated() Retrieves the task created date amd time in UTC.
java.lang.String	getDataGuid() Retrieves the data GUID of the task.
java.lang.String	getDescription() Retrieves the task description (typically the details) version 2002-12-16 fix008343
java.lang.String	getDtStamp() Retrieves the task created UTC timestamp.
java.lang.String	getDtStart() Retrieves the task start date and time.
java.lang.String	getDtStartValue() Retrieves the dtstart date or date-time parameter.
java.lang.String	getDue() Retrieves the task due date and time.
java.lang.String	getDueStartValue() Gets the data type of the dtstart parameter.
org.w3c.dom.Element	getElement(org.w3c.dom.Document in_document) Returns a new XML DOM structure representing the vTodo XML tree structure.
java.lang.String	getLastModified() Retrieves the task's last modification UTC timestamp.
java.lang.String	getPercent() Retrieves the task percent completed value.
java.lang.String	getPriority() Retrieves the task priority.
java.lang.String	getSummary() Retrieves the task summary (typically the task title).
java.lang.String	getTaskClass() Retrieves the task class of the vTask.
java.lang.String	getTaskId() Retrieves the CS task ID of the task.
java.lang.String	getUid() Retrieves the UID of the task.
java.lang.String	toString() Constructs a non-XML String representing the vTodo objects and all children.
static vTodo	unmarshall(org.w3c.dom.Element in_element) Constructs a new vTodo instance from the XML elements within the XML DOM.

Methods inherited from class java.lang.Object

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

Field Detail

k_vTodo

public static final java.lang.String k_vTodo

See Also:

Constant Field Values

k_taskClass

public static final java.lang.String k_taskClass

See Also:

Constant Field Values

k_completed

public static final java.lang.String k_completed

See Also:

Constant Field Values

k_created

public static final java.lang.String k_created

See Also:

Constant Field Values

k_description

public static final java.lang.String k_description

See Also:

Constant Field Values

k_dtstart

public static final java.lang.String k_dtstart

See Also:

Constant Field Values

k_dtstamp

public static final java.lang.String k_dtstamp

See Also:

Constant Field Values

k_due

public static final java.lang.String k_due

See Also:

Constant Field Values

k_lastModified

public static final java.lang.String k_lastModified

See Also:

Constant Field Values

k_percent

public static final java.lang.String k_percent

See Also:

Constant Field Values

k_priority

public static final java.lang.String k_priority

See Also:

Constant Field Values

k_summary

public static final java.lang.String k_summary

See Also:

Constant Field Values

k_uid

public static final java.lang.String k_uid

See Also:

Constant Field Values

k_dataGuid

public static final java.lang.String k_dataGuid

See Also:

Constant Field Values

k_taskId

public static final java.lang.String k_taskId

See Also:

Constant Field Values

k_value

public static final java.lang.String k_value

See Also:

Constant Field Values

k_taskClassPublic

public static final java.lang.String k_taskClassPublic

See Also:

Constant Field Values

k_taskClassPrivate

public static final java.lang.String k_taskClassPrivate

See Also:

Constant Field Values

k_taskClassConfidential

public static final java.lang.String k_taskClassConfidential

See Also:

Constant Field Values

k_valueTypeDate

public static final java.lang.String k_valueTypeDate

See Also:

Constant Field Values

k_valueTypeDateTime

public static final java.lang.String k_valueTypeDateTime

See Also:

Constant Field Values

Constructor Detail

vTodo

public vTodo()

Default constructor version 2002-12-16 fix008343

Method Detail

getUid

public java.lang.String getUid()

Retrieves the UID of the task. Note: A task UID is only unique to the owner's agenda. version 2002-12-16 fix008343

Returns:

String - task UID

getDataGuid

public java.lang.String getDataGuid()

Retrieves the data GUID of the task. This GUID can be reused to search by data GUID. version 2003-01-30 fix008476

Returns:

String - task data GUID

getTaskId

public java.lang.String getTaskId()

Retrieves the CS task ID of the task. version 2003-09-02 fix009565

Returns:

String - task CS ID

getTaskClass

public java.lang.String getTaskClass()

Retrieves the task class of the vTask. This can be either PUBLIC, PRIVATE, or CONFIDENTIAL. version 2002-12-16 fix008343

Returns:

String - task class

getCompleted

public java.lang.String getCompleted()

Retrieves the task completed status. version 2002-12-16 fix008343

Returns:

String - task completed status

getDescription

public java.lang.String getDescription()

Retrieves the task description (typically the details) version 2002-12-16 fix008343

Returns:

String - task description

getDtStart

public java.lang.String getDtStart()

Retrieves the task start date and time. The date and time is a UTC string of the form yyyymmddThhmmssZ. The value may also be a date. The date is a UTC string of the form yyyymmdd. version 2003-01-17 fix008443

Returns:

String - task start date and time or date value

getDtStartValue

public java.lang.String getDtStartValue()

Retrieves the dtstart date or date-time parameter. For a dtstart with time and date information, the value will be "DATE-TIME" or k_valueTypeDateTime. This is the default interpretation, if none is set. For a dtstart with date information only, the value will be "DATE" or k_valueTypeDate. version 2003-01-17 fix008443

Returns:

String - task start date and time or date value

getDtStamp

public java.lang.String getDtStamp()

Retrieves the task created UTC timestamp. version 2002-12-20 fix008364

Returns:

String - task created timestamp

getLastModified

public java.lang.String getLastModified()

Retrieves the task's last modification UTC timestamp. version 2002-12-20 fix008364

Returns:

String - task modify timestamp

getPercent

public java.lang.String getPercent()

Retrieves the task percent completed value. This is typically a number betwwen 1 and 100. version 2002-12-16 fix008343

Returns:

String - task percent completed status

getPriority

public java.lang.String getPriority()

Retrieves the task priority. version 2002-12-16 fix008343

Returns:

String - task priority

getSummary

public java.lang.String getSummary()

Retrieves the task summary (typically the task title). version 2002-12-16 fix008343

Returns:

String - task summary

getDue

public java.lang.String getDue()

Retrieves the task due date and time. The date and time is a UTC string of the form yyyymmddThhmmssZ. The value may also be a due date. The date is a UTC string of the form yyyymmdd. version 2003-01-17 fix008443

Returns:

String - task due date and time or date value

getDueStartValue

public java.lang.String getDueStartValue()

Gets the data type of the dtstart parameter. For a dtstart with time and date information, the value will be thhe string DATE-TIME or k_valueTypeDateTime. This is the default interpretation if none is set. For a dtstart with date information only, the value will be the string DATE or k_valueTypeDate. version 2003-01-17 fix008443

Returns:

String - "DATE-TIME" or "DATE"

getCreated

public java.lang.String getCreated()

Retrieves the task created date amd time in UTC. The string is of the form yyyymmddThhmmssZ. version 2002-12-20 fix008364

Returns:

String - task created date and time

unmarshall

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

Constructs a new vTodo instance from the XML elements within the XML DOM. version 2003-09-02 fix009565

Parameters:

in_element -

getElement

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

Returns a new XML DOM structure representing the vTodo XML tree structure. This is called internally when a Calendarlet command is being generated to DOM format. version 2002-12-19 fix008359

Overrides:

getElement in class vComponent

Returns:

Element - XML DOM element tree

toString

public java.lang.String toString()

Constructs a non-XML String representing the vTodo objects and all 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-09-02 fix009565

Overrides:

toString in class vComponent

Returns:

String a serialized vTodo