org.bedework.caldav.server

Class CalDAVCollectionBase<T extends CalDAVCollectionBase>

java.lang.Object

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

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

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

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

Type Parameters:

T -

All Implemented Interfaces:

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

public abstract class CalDAVCollectionBase<T extends CalDAVCollectionBase>
extends CalDAVCollection<T>

Simple implementation of class to represent a collection in CalDAV, used by the simpler interfaces.

Author:

douglm

Field Summary

Fields

Modifier and Type	Field and Description
static int	calTypeResource Resource collection.

Fields inherited from class org.bedework.caldav.server.CalDAVCollection

calTypeCalendarCollection, calTypeCollection, calTypeInbox, calTypeNotifications, calTypeOutbox, calTypeUnknown

Constructor Summary

Constructors

Constructor and Description
CalDAVCollectionBase(int calType, boolean freebusyAllowed) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	entitiesAllowed()
boolean	freebusyAllowed()
boolean	getAffectsFreeBusy()
String	getAliasUri() Get the calendar aliasUri property
int	getCalType()
String	getColor() Get the calendar color property
String	getRemoteId() Get the calendar remoteId property
String	getRemotePw() Get the calendar remotePw property
boolean	getSynchDeleteSuppressed() Get the deletions suppressed flag for synch
String	getTimezone() Get the collection timezone property
boolean	isAlias()
T	resolveAlias(boolean resolveSubAlias)
void	setAffectsFreeBusy(boolean val)
void	setAliasUri(String val) Set the calendar aliasUri property
void	setCalType(int val)
void	setColor(String val) Set the calendar color property
void	setRemoteId(String val) Set the calendar remoteId property
void	setRemotePw(String val) Set the calendar remotePw property
void	setSynchDeleteSuppressed(boolean val) Set the deletions suppressed flag for synch
void	setTimezone(String val) Set the collection timezone property

Methods inherited from class org.bedework.caldav.server.CalDAVCollection

getDeleted, getRefreshRate, getSupportedComponents, getVpollSupportedComponents, setRefreshRate, setSupportedComponents

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, 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

calTypeResource

public static final int calTypeResource

Resource collection. According to the CalDAV spec a collection may exist inside a calendar collection but no calendar collection must be so contained at any depth. (RFC 4791 Section 4.2)

See Also:

Constant Field Values

Constructor Detail

CalDAVCollectionBase

public CalDAVCollectionBase(int calType,
                            boolean freebusyAllowed)
                     throws org.bedework.webdav.servlet.shared.WebdavException

Constructor

Parameters:

calType -

freebusyAllowed -

Throws:

org.bedework.webdav.servlet.shared.WebdavException

Method Detail

isAlias

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

Specified by:

isAlias in class org.bedework.webdav.servlet.shared.WdEntity<T extends CalDAVCollectionBase>

Throws:

org.bedework.webdav.servlet.shared.WebdavException

resolveAlias

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

Specified by:

resolveAlias in class CalDAVCollection<T extends CalDAVCollectionBase>

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setCalType

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

Specified by:

setCalType in class CalDAVCollection<T extends CalDAVCollectionBase>

Parameters:

val - type

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getCalType

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

Specified by:

getCalType in class CalDAVCollection<T extends CalDAVCollectionBase>

Returns:

int

Throws:

org.bedework.webdav.servlet.shared.WebdavException

freebusyAllowed

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

Specified by:

freebusyAllowed in class CalDAVCollection<T extends CalDAVCollectionBase>

Returns:

true if freebusy reports are allowed

Throws:

org.bedework.webdav.servlet.shared.WebdavException

entitiesAllowed

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

Specified by:

entitiesAllowed in class CalDAVCollection<T extends CalDAVCollectionBase>

Returns:

true if entities can be stored

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setAffectsFreeBusy

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

Specified by:

setAffectsFreeBusy in class CalDAVCollection<T extends CalDAVCollectionBase>

Parameters:

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

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getAffectsFreeBusy

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

Specified by:

getAffectsFreeBusy in class CalDAVCollection<T extends CalDAVCollectionBase>

Returns:

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

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setTimezone

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

Description copied from class: CalDAVCollection

Set the collection timezone property

Specified by:

setTimezone in class CalDAVCollection<T extends CalDAVCollectionBase>

Parameters:

val - the tzid

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getTimezone

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

Description copied from class: CalDAVCollection

Get the collection timezone property

Specified by:

getTimezone in class CalDAVCollection<T extends CalDAVCollectionBase>

Returns:

String vtimezone spec

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setColor

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

Description copied from class: CalDAVCollection

Set the calendar color property

Specified by:

setColor in class CalDAVCollection<T extends CalDAVCollectionBase>

Parameters:

val - the color

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getColor

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

Description copied from class: CalDAVCollection

Get the calendar color property

Specified by:

getColor in class CalDAVCollection<T extends CalDAVCollectionBase>

Returns:

String calendar color

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setAliasUri

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

Description copied from class: CalDAVCollection

Set the calendar aliasUri property

Specified by:

setAliasUri in class CalDAVCollection<T extends CalDAVCollectionBase>

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getAliasUri

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

Description copied from class: CalDAVCollection

Get the calendar aliasUri property

Specified by:

getAliasUri in class CalDAVCollection<T extends CalDAVCollectionBase>

Returns:

String calendar AliasUri

Throws:

org.bedework.webdav.servlet.shared.WebdavException

setRemoteId

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

Description copied from class: CalDAVCollection

Set the calendar remoteId property

Specified by:

setRemoteId in class CalDAVCollection<T extends CalDAVCollectionBase>

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getRemoteId

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

Description copied from class: CalDAVCollection

Get the calendar remoteId property

Specified by:

getRemoteId in class CalDAVCollection<T extends CalDAVCollectionBase>

Returns:

String calendar RemoteId

Throws:

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

setRemotePw

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

Description copied from class: CalDAVCollection

Set the calendar remotePw property

Specified by:

setRemotePw in class CalDAVCollection<T extends CalDAVCollectionBase>

Parameters:

val - calendar remotePw property

Throws:

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

getRemotePw

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

Description copied from class: CalDAVCollection

Get the calendar remotePw property

Specified by:

getRemotePw in class CalDAVCollection<T extends CalDAVCollectionBase>

Returns:

String calendar RemotePw

Throws:

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

setSynchDeleteSuppressed

public void setSynchDeleteSuppressed(boolean val)

Description copied from class: CalDAVCollection

Set the deletions suppressed flag for synch

Specified by:

setSynchDeleteSuppressed in class CalDAVCollection<T extends CalDAVCollectionBase>

Parameters:

val - true if we suppress deletions during synch

getSynchDeleteSuppressed

public boolean getSynchDeleteSuppressed()

Description copied from class: CalDAVCollection

Get the deletions suppressed flag for synch

Specified by:

getSynchDeleteSuppressed in class CalDAVCollection<T extends CalDAVCollectionBase>

Returns:

boolean on/off