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:
java.lang.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 java.lang.String getAliasUri()
    Get the calendar aliasUri property
    abstract int getCalType()  
    abstract java.lang.String getColor()
    Get the calendar color property
    abstract boolean getDeleted()  
    abstract int getRefreshRate()
    Get the calendar refresh rate
    abstract java.lang.String getRemoteId()
    Get the calendar remoteId property
    abstract java.lang.String getRemotePw()
    Get the calendar remotePw property
    abstract java.util.List<java.lang.String> getSupportedComponents()  
    abstract boolean getSynchDeleteSuppressed()
    Get the deletions suppressed flag for synch
    abstract java.lang.String getTimezone()
    Get the collection timezone property
    abstract java.util.List<java.lang.String> getVpollSupportedComponents()  
    abstract T resolveAlias​(boolean resolveSubAlias)  
    abstract void setAffectsFreeBusy​(boolean val)  
    abstract void setAliasUri​(java.lang.String val)
    Set the calendar aliasUri property
    abstract void setCalType​(int val)  
    abstract void setColor​(java.lang.String val)
    Set the calendar color property
    abstract void setRefreshRate​(int val)
    Set the calendar refresh rate
    abstract void setRemoteId​(java.lang.String val)
    Set the calendar remoteId property
    abstract void setRemotePw​(java.lang.String val)
    Set the calendar remotePw property
    abstract void setSupportedComponents​(java.util.List<java.lang.String> val)  
    abstract void setSynchDeleteSuppressed​(boolean val)
    Set the deletions suppressed flag for synch
    abstract void setTimezone​(java.lang.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 Details

    • 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 Details

    • CalDAVCollection

      public CalDAVCollection()
      Constructor

  • Method Details

    • resolveAlias

      public abstract T resolveAlias​(boolean resolveSubAlias)
      Specified by:
      resolveAlias in class org.bedework.webdav.servlet.shared.WdEntity<T extends CalDAVCollection<?>>

    • setCalType

      public abstract void setCalType​(int val)
      Parameters:
      val - type

    • getCalType

      public abstract int getCalType()
      Returns:
      int

    • freebusyAllowed

      public abstract boolean freebusyAllowed()
      Returns:
      true if freebusy reports are allowed

    • getDeleted

      public abstract boolean getDeleted()
      Returns:
      true if this represents a deleted collection.

    • entitiesAllowed

      public abstract boolean entitiesAllowed()
      Returns:
      true if entities can be stored

    • setAffectsFreeBusy

      public abstract void setAffectsFreeBusy​(boolean val)
      Parameters:
      val - true if the calendar takes part in free/busy calculations

    • getAffectsFreeBusy

      public abstract boolean getAffectsFreeBusy()
      Returns:
      boolean true if the calendar takes part in free/busy calculations

    • setTimezone

      public abstract void setTimezone​(java.lang.String val)
      Set the collection timezone property
      Parameters:
      val - the tzid

    • getTimezone

      public abstract java.lang.String getTimezone()
      Get the collection timezone property
      Returns:
      String vtimezone spec

    • setColor

      public abstract void setColor​(java.lang.String val)
      Set the calendar color property
      Parameters:
      val - the color

    • getColor

      public abstract java.lang.String getColor()
      Get the calendar color property
      Returns:
      String calendar color

    • setAliasUri

      public abstract void setAliasUri​(java.lang.String val)
      Set the calendar aliasUri property
      Parameters:
      val - alias uri

    • getAliasUri

      public abstract java.lang.String getAliasUri()
      Get the calendar aliasUri property
      Specified by:
      getAliasUri in class org.bedework.webdav.servlet.shared.WdEntity<T extends CalDAVCollection<?>>
      Returns:
      String calendar AliasUri

    • setRefreshRate

      public abstract void setRefreshRate​(int val)
      Set the calendar refresh rate
      Parameters:
      val - - seconds

    • getRefreshRate

      public abstract int getRefreshRate()
      Get the calendar refresh rate
      Returns:
      int seconds

    • setRemoteId

      public abstract void setRemoteId​(java.lang.String val)
      Set the calendar remoteId property
      Parameters:
      val - remote id

    • getRemoteId

      public abstract java.lang.String getRemoteId()
      Get the calendar remoteId property
      Returns:
      String calendar RemoteId

    • setRemotePw

      public abstract void setRemotePw​(java.lang.String val)
      Set the calendar remotePw property
      Parameters:
      val - calendar remotePw property

    • getRemotePw

      public abstract java.lang.String getRemotePw()
      Get the calendar remotePw property
      Returns:
      String calendar RemotePw

    • setSynchDeleteSuppressed

      public abstract void setSynchDeleteSuppressed​(boolean val)
      Set the deletions suppressed flag for synch
      Parameters:
      val - true if we suppress deletions during synch

    • getSynchDeleteSuppressed

      public abstract boolean getSynchDeleteSuppressed()
      Get the deletions suppressed flag for synch
      Returns:
      boolean on/off

    • setSupportedComponents

      public abstract void setSupportedComponents​(java.util.List<java.lang.String> val)
      Parameters:
      val - the supported component names e.g. "VEVENT", "VTODO" etc.

    • getSupportedComponents

      public abstract java.util.List<java.lang.String> getSupportedComponents()
      Returns:
      the supported component names e.g. "VEVENT", "VTODO" etc.

    • getVpollSupportedComponents

      public abstract java.util.List<java.lang.String> getVpollSupportedComponents()
      Returns:
      the vpoll supported component names e.g. "VEVENT", "VTODO" etc.