Package org.bedework.caldav.server

Class CalDAVCollection<T extends CalDAVCollection>

java.lang.Object

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

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

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

Type Parameters:

T -

All Implemented Interfaces:

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

Direct Known Subclasses:

CalDAVCollectionBase

public abstract class CalDAVCollection<T extends CalDAVCollection>
extends org.bedework.webdav.servlet.shared.WdCollection<T>

Class to represent a collection in CalDAV

Author:

douglm

Field Summary

Fields

Modifier and Type	Field	Description
static int	calTypeCalendarCollection	Normal calendar collection
static int	calTypeCollection	Normal folder
static int	calTypeInbox	Inbox
static int	calTypeNotifications	Outbox
static int	calTypeOutbox	Outbox
static int	calTypeUnknown	Indicate unknown type

Constructor Summary

Constructors

Constructor	Description
CalDAVCollection()	Constructor

Method Summary

Modifier and Type	Method	Description
abstract boolean	entitiesAllowed()
abstract boolean	freebusyAllowed()
abstract boolean	getAffectsFreeBusy()
abstract String	getAliasUri()	Get the calendar aliasUri property
abstract int	getCalType()
abstract String	getColor()	Get the calendar color property
abstract boolean	getDeleted()
abstract int	getRefreshRate()	Get the calendar refresh rate
abstract String	getRemoteId()	Get the calendar remoteId property
abstract String	getRemotePw()	Get the calendar remotePw property
abstract List<String>	getSupportedComponents()
abstract boolean	getSynchDeleteSuppressed()	Get the deletions suppressed flag for synch
abstract String	getTimezone()	Get the collection timezone property
abstract List<String>	getVpollSupportedComponents()
abstract T	resolveAlias(boolean resolveSubAlias)
abstract void	setAffectsFreeBusy(boolean val)
abstract void	setAliasUri(String val)	Set the calendar aliasUri property
abstract void	setCalType(int val)
abstract void	setColor(String val)	Set the calendar color property
abstract void	setRefreshRate(int val)	Set the calendar refresh rate
abstract void	setRemoteId(String val)	Set the calendar remoteId property
abstract void	setRemotePw(String val)	Set the calendar remotePw property
abstract void	setSupportedComponents(List<String> val)
abstract void	setSynchDeleteSuppressed(boolean val)	Set the deletions suppressed flag for synch
abstract void	setTimezone(String val)	Set the collection timezone property

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

compareTo, getCanPublish, getCanShare, getCreated, getDescription, getDisplayName, getEtag, getLastmod, getName, getOwner, getParentPath, getPath, getPreviousEtag, getProperty, hashCode, isAlias, 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

Field Detail

calTypeUnknown

public static final int calTypeUnknown

Indicate unknown type

See Also:

Constant Field Values

calTypeCollection

public static final int calTypeCollection

Normal folder

See Also:

Constant Field Values

calTypeCalendarCollection

public static final int calTypeCalendarCollection

Normal calendar collection

See Also:

Constant Field Values

calTypeInbox

public static final int calTypeInbox

Inbox

See Also:

Constant Field Values

calTypeOutbox

public static final int calTypeOutbox

Outbox

See Also:

Constant Field Values

calTypeNotifications

public static final int calTypeNotifications

Outbox

See Also:

Constant Field Values

Constructor Detail

CalDAVCollection

public CalDAVCollection()

Constructor

Method Detail

resolveAlias

public abstract T resolveAlias(boolean resolveSubAlias)
                        throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

resolveAlias in class org.bedework.webdav.servlet.shared.WdEntity<T extends CalDAVCollection>

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setCalType

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

Parameters:

val - type

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getCalType

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

Returns:

int

Throws:

org.bedework.webdav.servlet.shared.WebdavException

freebusyAllowed

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

Returns:

true if freebusy reports are allowed

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

Throws:

org.bedework.webdav.servlet.shared.WebdavException

entitiesAllowed

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

Returns:

true if entities can be stored

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setAffectsFreeBusy

public abstract void setAffectsFreeBusy(boolean val)
                                 throws org.bedework.webdav.servlet.shared.WebdavException

Parameters:

val - true if the calendar takes part in free/busy calculations

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getAffectsFreeBusy

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

Returns:

boolean true if the calendar takes part in free/busy calculations

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setTimezone

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

Set the collection timezone property

Parameters:

val - the tzid

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getTimezone

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

Get the collection timezone property

Returns:

String vtimezone spec

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setColor

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

Set the calendar color property

Parameters:

val - the color

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getColor

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

Get the calendar color property

Returns:

String calendar color

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setAliasUri

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

Set the calendar aliasUri property

Parameters:

val -

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getAliasUri

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

Get the calendar aliasUri property

Specified by:

getAliasUri in class org.bedework.webdav.servlet.shared.WdEntity<T extends CalDAVCollection>

Returns:

String calendar AliasUri

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setRefreshRate

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

Set the calendar refresh rate

Parameters:

val - - seconds

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal eror

getRefreshRate

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

Get the calendar refresh rate

Returns:

int seconds

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal eror

setRemoteId

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

Set the calendar remoteId property

Parameters:

val -

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getRemoteId

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

Get the calendar remoteId property

Returns:

String calendar RemoteId

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

setRemotePw

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

Set the calendar remotePw property

Parameters:

val - calendar remotePw property

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

getRemotePw

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

Get the calendar remotePw property

Returns:

String calendar RemotePw

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

setSynchDeleteSuppressed

public abstract void setSynchDeleteSuppressed(boolean val)
                                       throws org.bedework.webdav.servlet.shared.WebdavException

Set the deletions suppressed flag for synch

Parameters:

val - true if we suppress deletions during synch

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

getSynchDeleteSuppressed

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

Get the deletions suppressed flag for synch

Returns:

boolean on/off

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

setSupportedComponents

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

Parameters:

val - the supported component names e.g. "VEVENT", "VTODO" etc.

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

getSupportedComponents

public abstract List<String> getSupportedComponents()
                                             throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

the supported component names e.g. "VEVENT", "VTODO" etc.

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getVpollSupportedComponents

public abstract List<String> getVpollSupportedComponents()
                                                  throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

the vpoll supported component names e.g. "VEVENT", "VTODO" etc.

Throws:

org.bedework.webdav.servlet.shared.WebdavException