oracle.calendar.soap.iCal
Class vTodo

java.lang.Object
  |
  +--oracle.calendar.soap.iCal.vComponent
        |
        +--oracle.calendar.soap.iCal.vTodo

public class vTodo

extends vComponent

The vTodo mirrors the IETF definition of a vTodo. The component contains information about a task. This task, for the current 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_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
private java.lang.String	m_completed
private java.lang.String	m_created
private java.lang.String	m_dataGuid
private java.lang.String	m_description
private java.lang.String	m_dtstamp
private java.lang.String	m_dtstart
private java.lang.String	m_dtstartvalue
private java.lang.String	m_due
private java.lang.String	m_duevalue
private java.lang.String	m_lastModified
private java.lang.String	m_percent
private java.lang.String	m_priority
private java.lang.String	m_summary
private java.lang.String	m_taskClass
private java.lang.String	m_uid

Constructor Summary

vTodo()
Default constructor

Method Summary

java.lang.String	getCompleted() Retrieves the task completed status.
java.lang.String	getCreated() Retrieves the task created date in UTC.
java.lang.String	getDataGuid() Retrieves the Data GUID of the task.
java.lang.String	getDescription() Retrieves the task description (typically the details)
java.lang.String	getDtStamp() Retrieves the task created UTC timestamp.
java.lang.String	getDtStart() Retrieves the task start date-time.
java.lang.String	getDtStartValue() Gets the dtstart date or date-time parameter.
java.lang.String	getDue() Retrieves the task due date-time.
java.lang.String	getDueStartValue() Gets the dtstart date or date-time 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	getUid() Retrieves the UID of the task.
java.lang.String	toString() Constructs a 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

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

Field Detail

k_vTodo

public static final java.lang.String k_vTodo

k_taskClass

public static final java.lang.String k_taskClass

k_completed

public static final java.lang.String k_completed

k_created

public static final java.lang.String k_created

k_description

public static final java.lang.String k_description

k_dtstart

public static final java.lang.String k_dtstart

k_dtstamp

public static final java.lang.String k_dtstamp

k_due

public static final java.lang.String k_due

k_lastModified

public static final java.lang.String k_lastModified

k_percent

public static final java.lang.String k_percent

k_priority

public static final java.lang.String k_priority

k_summary

public static final java.lang.String k_summary

k_uid

public static final java.lang.String k_uid

k_dataGuid

public static final java.lang.String k_dataGuid

k_value

public static final java.lang.String k_value

k_taskClassPublic

public static final java.lang.String k_taskClassPublic

k_taskClassPrivate

public static final java.lang.String k_taskClassPrivate

k_taskClassConfidential

public static final java.lang.String k_taskClassConfidential

k_valueTypeDate

public static final java.lang.String k_valueTypeDate

k_valueTypeDateTime

public static final java.lang.String k_valueTypeDateTime

m_created

private java.lang.String m_created

m_description

private java.lang.String m_description

m_dtstamp

private java.lang.String m_dtstamp

m_due

private java.lang.String m_due

m_duevalue

private java.lang.String m_duevalue

m_lastModified

private java.lang.String m_lastModified

m_percent

private java.lang.String m_percent

m_priority

private java.lang.String m_priority

m_summary

private java.lang.String m_summary

m_taskClass

private java.lang.String m_taskClass

m_uid

private java.lang.String m_uid

m_dataGuid

private java.lang.String m_dataGuid

m_completed

private java.lang.String m_completed

m_dtstart

private java.lang.String m_dtstart

m_dtstartvalue

private java.lang.String m_dtstartvalue

Constructor Detail

vTodo

public vTodo()

Default constructor

Method Detail

getUid

public java.lang.String getUid()

Retrieves the UID of the task. It is important to note that a task UID is only unique to the owner's agenda.

Returns:

String the meeting UID

getDataGuid

public java.lang.String getDataGuid()

Retrieves the Data GUID of the task. This GUID can be reused to search by data GUID

Returns:

String the meeting Data GUID

getTaskClass

public java.lang.String getTaskClass()

Retrieves the task class of the vTask. This

• PUBLIC
• PRIVATE
• CONFIDENTIAL

  Returns:

  String the task class

  getCompleted

  public java.lang.String getCompleted()
  

  Retrieves the task completed status.

  Returns:

  String the task completed status

  getDescription

  public java.lang.String getDescription()
  

  Retrieves the task description (typically the details)

  Returns:

  String the task description

  getDtStart

  public java.lang.String getDtStart()
  

  Retrieves the task start date-time. The date time is a UTC string of the form

  • yyyymmddThhmmssZ The value may also be a start date. The date is a UTC string of the form
  • yyyymmdd

    Returns:

    String an task start date time or date

    getDtStartValue

    public java.lang.String getDtStartValue()
    

    Gets 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.

    Returns:

    String an task start date time value

    getDtStamp

    public java.lang.String getDtStamp()
    

    Retrieves the task created UTC timestamp.

    Returns:

    String the task created timestamp

    getLastModified

    public java.lang.String getLastModified()
    

    Retrieves the task's last modification UTC timestamp.

    Returns:

    String the task modify timestamp

    getPercent

    public java.lang.String getPercent()
    

    Retrieves the task percent completed value. This is typically a number betwwen 1 and 100.

    Returns:

    String the task percent completed status

    getPriority

    public java.lang.String getPriority()
    

    Retrieves the task priority.

    Returns:

    String the task priority

    getSummary

    public java.lang.String getSummary()
    

    Retrieves the task summary (typically the task title)

    Returns:

    String the task summary

    getDue

    public java.lang.String getDue()
    

    Retrieves the task due date-time. The date 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

      Returns:

      String an task due date time or date

      getDueStartValue

      public java.lang.String getDueStartValue()
      

      Gets 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.

      Returns:

      String an task due date time value

      getCreated

      public java.lang.String getCreated()
      

      Retrieves the task created date in UTC. The string is of the form

      • yyyymmddThhmmssZ

        Returns:

        String the task created date

        unmarshall

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

        Constructs a new vTodo instance from the XML elements within the XML DOM.

        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.

        Overrides:

        getElement in class vComponent

        Returns:

        Element an XML DOM element tree

        toString

        public java.lang.String toString()
        

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

        Overrides:

        toString in class vComponent

        Returns:

        String a serialized vTodo