Interface IcalCallback

All Superinterfaces:
Serializable

public interface IcalCallback extends Serializable
Allow the translation process to retrieve objects and information it might need from the system.
Version:
1.0
Author:
Mike Douglass douglm@rpi.edu
  • Field Details

  • Method Details

    • setStrictness

      void setStrictness(int val)
      Set the conformance
      Parameters:
      val -
    • getStrictness

      int getStrictness()
      Get the conformance level. This relates to handling itip etc. Should we be extra picky, just complain or let it all through.

      For example, rfc2446 say's no attendees for method PUBLISH. If we are actually handling an itip interaction then we should probably stick to the rules. If the user is just doing an import of an event then maybe we can be more relaxed about things.

      Returns:
      int level of conformance.
    • getPrincipal

      BwPrincipal getPrincipal()
      Get the current principal
      Returns:
      BwPrincipal object
    • getOwner

      BwPrincipal getOwner()
      Get the current principal to set as owner
      Returns:
      BwPrincipal object
    • getCaladdr

      String getCaladdr(String val)
      Return a calendar user address corresponding to the supplied value. We may have been supplied with a user principal.
      Parameters:
      val - user account or principal
      Returns:
      caladdr of form mailto:x@y we hope.
    • findCategory

      org.bedework.util.misc.response.GetEntityResponse<BwCategory> findCategory(BwString val)
      Look for the given category for this user. Return null for not found. This returns a persistent object and is only for use when reconstructing events from a calendar input stream.
      Parameters:
      val - identifying category
      Returns:
      Response with Category object
    • addCategory

      void addCategory(BwCategory val)
      Add the given category.
      Parameters:
      val -
    • getContact

      org.bedework.util.misc.response.GetEntityResponse<BwContact> getContact(String uid)
      Get the contact with the given uid.
      Parameters:
      uid -
      Returns:
      contact object
    • findContact

      org.bedework.util.misc.response.GetEntityResponse<BwContact> findContact(BwString val)
      Find the contact.
      Parameters:
      val - identifying contact
      Returns:
      response with contact object
    • addContact

      void addContact(BwContact val)
      Add the contact
      Parameters:
      val -
    • getLocation

      org.bedework.util.misc.response.GetEntityResponse<BwLocation> getLocation(String uid)
      Get the location with the given uid.
      Parameters:
      uid -
      Returns:
      status and Location object
    • fetchLocationByKey

      org.bedework.util.misc.response.GetEntityResponse<BwLocation> fetchLocationByKey(String name, String val)
      Find a location owned by the current user which has a named key field which matches the value.
      Parameters:
      name - - of key field
      val - - expected full value
      Returns:
      null or location object
    • findLocation

      org.bedework.util.misc.response.GetEntityResponse<BwLocation> findLocation(BwString address)
      Find the location given the address.

      NOTE: the addition of multi-valued fields to the location object has led to some possible issues. Setting and accessing the address field should continue to work for personal clients that treat it as a single value.

      Public events will not be able to match on the address field. Use the combined value as a key and use the findLocationByCombined

      Parameters:
      address -
      Returns:
      Response with status and Location object
    • fetchLocationByCombined

      org.bedework.util.misc.response.GetEntityResponse<BwLocation> fetchLocationByCombined(String val, boolean persisted)
      Find the location given the combined address values.
      Parameters:
      val - - address, room, city, state, zip
      persisted - - true if we want the db copy
      Returns:
      Location object
    • addLocation

      void addLocation(BwLocation val)
      Add the location
      Parameters:
      val -
    • getEvent

      org.bedework.util.misc.response.GetEntitiesResponse<EventInfo> getEvent(String colPath, String guid)
      Return a Collection of EventInfo objects. There should only be one returned.
      Parameters:
      colPath - of collection to search
      guid - of entity
      Returns:
      Collection of EventInfo
    • getTimezonesByReference

      boolean getTimezonesByReference()
      Returns:
      true if we are not including the full tz specification