org.bedework.icalendar

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 Summary

Fields

Modifier and Type	Field and Description
static int	conformanceRelaxed
static int	conformanceStrict
static int	conformanceWarn

Method Summary

Modifier and Type	Method and Description
void	addCategory(BwCategory val) Add the given category.
void	addContact(BwContact val) Add the contact
void	addLocation(BwLocation val) Add the location
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.
BwCategory	findCategory(BwString val) Look for the given category for this user.
BwContact	findContact(BwString val) Find the contact.
BwLocation	findLocation(BwString address) Find the location given the address.
String	getCaladdr(String val) Return a calendar user address corresponding to the supplied value.
BwContact	getContact(String uid) Get the contact with the given uid.
Collection<EventInfo>	getEvent(String colPath, String guid) Return a Collection of EventInfo objects.
BwLocation	getLocation(BwString address) Get the location with the given address.
BwLocation	getLocation(String uid) Get the location with the given uid.
BwPrincipal	getOwner() Get the current principal to set as owner
BwPrincipal	getPrincipal() Get the current principal
int	getStrictness() Get the conformance level.
boolean	getTimezonesByReference()
void	setStrictness(int val) Set the conformance

Field Detail

conformanceRelaxed

static final int conformanceRelaxed

See Also:

Constant Field Values

conformanceWarn

static final int conformanceWarn

See Also:

Constant Field Values

conformanceStrict

static final int conformanceStrict

See Also:

Constant Field Values

Method Detail

setStrictness

void setStrictness(int val)
            throws CalFacadeException

Set the conformance

Parameters:

val -

Throws:

CalFacadeException

getStrictness

int getStrictness()
           throws CalFacadeException

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.

Throws:

CalFacadeException

getPrincipal

BwPrincipal getPrincipal()
                  throws CalFacadeException

Get the current principal

Returns:

BwPrincipal object

Throws:

CalFacadeException

getOwner

BwPrincipal getOwner()
              throws CalFacadeException

Get the current principal to set as owner

Returns:

BwPrincipal object

Throws:

CalFacadeException

getCaladdr

String getCaladdr(String val)
           throws CalFacadeException

Return a calendar user address corresponding to the supplied value. We may have been supplied with a user principal.

Parameters:

val -

Returns:

caladdr of form mailto:x@y we hope.

Throws:

CalFacadeException

findCategory

BwCategory findCategory(BwString val)
                 throws CalFacadeException

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 -

Returns:

Category object

Throws:

CalFacadeException

addCategory

void addCategory(BwCategory val)
          throws CalFacadeException

Add the given category.

Parameters:

val -

Throws:

CalFacadeException

getContact

BwContact getContact(String uid)
              throws CalFacadeException

Get the contact with the given uid.

Parameters:

uid -

Returns:

contact object

Throws:

CalFacadeException

findContact

BwContact findContact(BwString val)
               throws CalFacadeException

Find the contact.

Parameters:

val -

Returns:

contact object

Throws:

CalFacadeException

addContact

void addContact(BwContact val)
         throws CalFacadeException

Add the contact

Parameters:

val -

Throws:

CalFacadeException

getLocation

BwLocation getLocation(String uid)
                throws CalFacadeException

Get the location with the given uid.

Parameters:

uid -

Returns:

Location object

Throws:

CalFacadeException

getLocation

BwLocation getLocation(BwString address)
                throws CalFacadeException

Get the location with the given address.

Parameters:

address - to find

Returns:

Location object or null if not found

Throws:

CalFacadeException

fetchLocationByKey

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

BwLocation findLocation(BwString address)
                 throws CalFacadeException

Find the location given the address.

Parameters:

address -

Returns:

Location object

Throws:

CalFacadeException

addLocation

void addLocation(BwLocation val)
          throws CalFacadeException

Add the location

Parameters:

val -

Throws:

CalFacadeException

getEvent

Collection<EventInfo> getEvent(String colPath,
                               String guid)
                        throws CalFacadeException

Return a Collection of EventInfo objects. There should only be one returned.

Parameters:

colPath - of collection to search

guid -

Returns:

Collection of EventInfo

Throws:

CalFacadeException

getTimezonesByReference

boolean getTimezonesByReference()
                         throws CalFacadeException

Returns:

true if we are not including the full tz specification

Throws:

CalFacadeException