org.bedework.caldav.server

Class CalDAVEvent<T>

java.lang.Object

org.bedework.webdav.servlet.shared.WdEntity<T>

org.bedework.caldav.server.CalDAVEvent<T>

Type Parameters:

T -

All Implemented Interfaces:

Comparable<org.bedework.webdav.servlet.shared.WdEntity>

public abstract class CalDAVEvent<T>
extends org.bedework.webdav.servlet.shared.WdEntity<T>

Class to represent an event/journal/task in CalDAV

Author:

douglm

Constructor Summary

Constructors

Constructor and Description
CalDAVEvent() Constructor

Method Summary

Modifier and Type	Method and Description
abstract void	addRecipient(String val)
abstract boolean	generatePropertyValue(QName tag, org.bedework.util.xml.XmlEmit xml)
abstract boolean	getAttendeeSchedulingObject() True if this is a valid attendee scheduling object.
abstract Set<String>	getAttendeeUris()
abstract boolean	getDeleted()
abstract int	getEntityType()
abstract Organizer	getOrganizer()
abstract boolean	getOrganizerSchedulingObject() True if this is a valid organizer scheduling object.
abstract String	getPrevScheduleTag()
abstract Set<String>	getRecipients()
abstract int	getScheduleMethod() Get the scheduleMethod for this event.
abstract String	getScheduleTag()
abstract String	getSummary()
abstract String	getUid()
abstract boolean	isNew()
abstract void	setOrganizer(Organizer val)
abstract void	setOriginator(String val) Set the event's originator
abstract void	setRecipients(Set<String> val)
abstract void	setScheduleMethod(int val) Set the scheduleMethod for this event.
abstract String	toIcalString(int methodType, String contentType) Return a complete representation of the event

Methods inherited from class org.bedework.webdav.servlet.shared.WdEntity

compareTo, getAliasUri, getCanPublish, getCanShare, getCreated, getDescription, getDisplayName, getEtag, getLastmod, getName, getOwner, getParentPath, getPath, getPreviousEtag, getProperty, hashCode, isAlias, resolveAlias, setCreated, setDescription, setDisplayName, setLastmod, setName, setOwner, setParentPath, setPath, setProperty, toString, toStringSegment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CalDAVEvent

public CalDAVEvent()
            throws org.bedework.webdav.servlet.shared.WebdavException

Constructor

Throws:

org.bedework.webdav.servlet.shared.WebdavException

Method Detail

getScheduleTag

public abstract String getScheduleTag()
                               throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

String schedule-tag (unquoted)

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getOrganizerSchedulingObject

public abstract boolean getOrganizerSchedulingObject()
                                              throws org.bedework.webdav.servlet.shared.WebdavException

True if this is a valid organizer scheduling object. (See CalDAV scheduling specification).

Returns:

boolean

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getAttendeeSchedulingObject

public abstract boolean getAttendeeSchedulingObject()
                                             throws org.bedework.webdav.servlet.shared.WebdavException

True if this is a valid attendee scheduling object. (See CalDAV scheduling specification)

Returns:

boolean

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getPrevScheduleTag

public abstract String getPrevScheduleTag()
                                   throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

String schedule-tag (unquoted)

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getSummary

public abstract String getSummary()
                           throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

String summary

Throws:

org.bedework.webdav.servlet.shared.WebdavException

isNew

public abstract boolean isNew()
                       throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

boolean true if this will be created as a result of a Put

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getDeleted

public abstract boolean getDeleted()
                            throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

true if this represents a deleted event.

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getEntityType

public abstract int getEntityType()
                           throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

entity type defined in org.bedework.util.calendar.IcalDefs

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setOrganizer

public abstract void setOrganizer(Organizer val)
                           throws org.bedework.webdav.servlet.shared.WebdavException

Parameters:

val - Organizer

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getOrganizer

public abstract Organizer getOrganizer()
                                throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

an organizer if one is present.

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setOriginator

public abstract void setOriginator(String val)
                            throws org.bedework.webdav.servlet.shared.WebdavException

Set the event's originator

Parameters:

val - String event's originator

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setRecipients

public abstract void setRecipients(Set<String> val)
                            throws org.bedework.webdav.servlet.shared.WebdavException

Parameters:

val -

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getRecipients

public abstract Set<String> getRecipients()
                                   throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

recipients

Throws:

org.bedework.webdav.servlet.shared.WebdavException

addRecipient

public abstract void addRecipient(String val)
                           throws org.bedework.webdav.servlet.shared.WebdavException

Parameters:

val -

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getAttendeeUris

public abstract Set<String> getAttendeeUris()
                                     throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

attendee uris

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setScheduleMethod

public abstract void setScheduleMethod(int val)
                                throws org.bedework.webdav.servlet.shared.WebdavException

Set the scheduleMethod for this event. Takes methodType values defined in Icalendar

Parameters:

val - scheduleMethod

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getScheduleMethod

public abstract int getScheduleMethod()
                               throws org.bedework.webdav.servlet.shared.WebdavException

Get the scheduleMethod for this event. Takes methodType values defined in Icalendar

Returns:

the method

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getUid

public abstract String getUid()
                       throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

String uid

Throws:

org.bedework.webdav.servlet.shared.WebdavException

generatePropertyValue

public abstract boolean generatePropertyValue(QName tag,
                                              org.bedework.util.xml.XmlEmit xml)
                                       throws org.bedework.webdav.servlet.shared.WebdavException

Parameters:

tag -

xml -

Returns:

boolean true if value emitted.

Throws:

org.bedework.webdav.servlet.shared.WebdavException

toIcalString

public abstract String toIcalString(int methodType,
                                    String contentType)
                             throws org.bedework.webdav.servlet.shared.WebdavException

Return a complete representation of the event

Parameters:

methodType -

Returns:

String ical representation

Throws:

org.bedework.webdav.servlet.shared.WebdavException