Package 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 -
Method Summary
Modifier and TypeMethodDescriptionabstract voidaddRecipient(String val) abstract booleangeneratePropertyValue(QName tag, org.bedework.util.xml.XmlEmit xml) abstract booleanTrue if this is a valid attendee scheduling object.abstract booleanabstract intabstract Organizerabstract booleanTrue if this is a valid organizer scheduling object.abstract Stringabstract intGet the scheduleMethod for this event.abstract Stringabstract Stringabstract StringgetUid()abstract booleanisNew()abstract voidsetOrganizer(Organizer val) abstract voidsetOriginator(String val) Set the event's originatorabstract voidsetRecipients(Set<String> val) abstract voidsetScheduleMethod(int val) Set the scheduleMethod for this event.abstract StringtoIcalString(int methodType, String contentType) Return a complete representation of the eventMethods 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
-
Constructor Details
-
CalDAVEvent
public CalDAVEvent()Constructor
-
-
Method Details
-
getScheduleTag
- Returns:
- String schedule-tag (unquoted)
- Throws:
org.bedework.webdav.servlet.shared.WebdavException
-
getOrganizerSchedulingObject
public abstract boolean getOrganizerSchedulingObject() throws org.bedework.webdav.servlet.shared.WebdavExceptionTrue 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.WebdavExceptionTrue 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
- 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
- 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.WebdavExceptionGet the scheduleMethod for this event. Takes methodType values defined in Icalendar- Returns:
- the method
- Throws:
org.bedework.webdav.servlet.shared.WebdavException
-
getUid
- 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
-