com.xpn.xwiki.plugin.calendar
Class CalendarPluginApi

java.lang.Object
  extended bycom.xpn.xwiki.api.Api
      extended bycom.xpn.xwiki.plugin.calendar.CalendarPluginApi

public class CalendarPluginApi
extends Api


Field Summary
private  CalendarPlugin plugin
           
 
Fields inherited from class com.xpn.xwiki.api.Api
context
 
Constructor Summary
CalendarPluginApi(CalendarPlugin plugin, XWikiContext context)
           
 
Method Summary
 CalendarData fromCalendar(net.fortuna.ical4j.model.Calendar calendar, java.lang.String user)
           
 java.util.Calendar getCalendar()
           
 java.util.Calendar getCalendar(long time)
           
 net.fortuna.ical4j.model.Calendar getCalendar(java.lang.String surl)
           
 net.fortuna.ical4j.model.Calendar getCalendar(java.lang.String surl, java.lang.String username, java.lang.String password)
           
 CalendarEvent getCalendarEvent()
           
 CalendarEvent getCalendarEvent(java.util.Calendar dateStart, java.util.Calendar dateEnd, java.lang.String user, java.lang.String description)
           
 CalendarEvent getCalendarEvent(java.util.Date dateStart, java.util.Date dateEnd, java.lang.String user, java.lang.String description)
           
 CalendarData getCalendarEvents(java.lang.String surl, java.lang.String user)
           
 CalendarData getCalendarEvents(java.lang.String surl, java.lang.String user, java.lang.String username, java.lang.String password)
           
 CalendarParams getCalendarParams()
           
 CalendarParams getCalendarParams(java.lang.String month, java.lang.String year)
           
 java.lang.String getHTMLCalendar(CalendarParams calendarParams, CalendarData calendarData)
           
 java.lang.String getHTMLCalendar(CalendarParams calendarParams, Document doc, java.lang.String user)
           
 java.lang.String getHTMLCalendar(CalendarParams calendarParams, java.lang.String user)
           
 java.lang.String getHTMLCalendar(CalendarParams calendarParams, java.lang.String hql, int nb)
           
 java.lang.String getHTMLCalendar(CalendarParams calendarParams, java.lang.String hql, java.lang.String user)
           
 java.lang.String getHTMLCalendarFromICal(CalendarParams calendarParams, java.lang.String surl, java.lang.String user)
           
 java.lang.String getHTMLCalendarFromICal(CalendarParams calendarParams, java.lang.String surl, java.lang.String user, java.lang.String username, java.lang.String password)
           
 CalendarPlugin getPlugin()
           
 void setPlugin(CalendarPlugin plugin)
           
 net.fortuna.ical4j.model.Calendar toCalendar(CalendarData data)
           
 java.lang.String toICal(CalendarData data)
           
 java.lang.String toICal(Document doc, java.lang.String user)
           
 java.lang.String toICal(java.lang.String user)
           
 
Methods inherited from class com.xpn.xwiki.api.Api
checkProgrammingRights, hasAccessLevel, hasAdminRights, hasProgrammingRights
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

plugin

private CalendarPlugin plugin
Constructor Detail

CalendarPluginApi

public CalendarPluginApi(CalendarPlugin plugin,
                         XWikiContext context)
Method Detail

getCalendarParams

public CalendarParams getCalendarParams(java.lang.String month,
                                        java.lang.String year)

getHTMLCalendar

public java.lang.String getHTMLCalendar(CalendarParams calendarParams,
                                        java.lang.String user)
                                 throws XWikiException
Throws:
XWikiException

getHTMLCalendar

public java.lang.String getHTMLCalendar(CalendarParams calendarParams,
                                        Document doc,
                                        java.lang.String user)
                                 throws XWikiException
Throws:
XWikiException

getHTMLCalendar

public java.lang.String getHTMLCalendar(CalendarParams calendarParams,
                                        java.lang.String hql,
                                        java.lang.String user)
                                 throws XWikiException
Throws:
XWikiException

getHTMLCalendar

public java.lang.String getHTMLCalendar(CalendarParams calendarParams,
                                        java.lang.String hql,
                                        int nb)
                                 throws XWikiException
Throws:
XWikiException

getHTMLCalendar

public java.lang.String getHTMLCalendar(CalendarParams calendarParams,
                                        CalendarData calendarData)
                                 throws XWikiException
Throws:
XWikiException

getCalendarParams

public CalendarParams getCalendarParams()

getCalendarEvent

public CalendarEvent getCalendarEvent()

getCalendarEvent

public CalendarEvent getCalendarEvent(java.util.Calendar dateStart,
                                      java.util.Calendar dateEnd,
                                      java.lang.String user,
                                      java.lang.String description)

getCalendarEvent

public CalendarEvent getCalendarEvent(java.util.Date dateStart,
                                      java.util.Date dateEnd,
                                      java.lang.String user,
                                      java.lang.String description)

getPlugin

public CalendarPlugin getPlugin()

setPlugin

public void setPlugin(CalendarPlugin plugin)

getCalendar

public java.util.Calendar getCalendar(long time)

getCalendar

public java.util.Calendar getCalendar()

getCalendar

public net.fortuna.ical4j.model.Calendar getCalendar(java.lang.String surl)
                                              throws net.fortuna.ical4j.data.ParserException,
                                                     java.io.IOException
Throws:
net.fortuna.ical4j.data.ParserException
java.io.IOException

getCalendar

public net.fortuna.ical4j.model.Calendar getCalendar(java.lang.String surl,
                                                     java.lang.String username,
                                                     java.lang.String password)
                                              throws net.fortuna.ical4j.data.ParserException,
                                                     java.io.IOException
Throws:
net.fortuna.ical4j.data.ParserException
java.io.IOException

getCalendarEvents

public CalendarData getCalendarEvents(java.lang.String surl,
                                      java.lang.String user)
                               throws net.fortuna.ical4j.data.ParserException,
                                      java.io.IOException
Throws:
net.fortuna.ical4j.data.ParserException
java.io.IOException

getCalendarEvents

public CalendarData getCalendarEvents(java.lang.String surl,
                                      java.lang.String user,
                                      java.lang.String username,
                                      java.lang.String password)
                               throws net.fortuna.ical4j.data.ParserException,
                                      java.io.IOException
Throws:
net.fortuna.ical4j.data.ParserException
java.io.IOException

fromCalendar

public CalendarData fromCalendar(net.fortuna.ical4j.model.Calendar calendar,
                                 java.lang.String user)

toCalendar

public net.fortuna.ical4j.model.Calendar toCalendar(CalendarData data)

toICal

public java.lang.String toICal(CalendarData data)

toICal

public java.lang.String toICal(Document doc,
                               java.lang.String user)
                        throws XWikiException
Throws:
XWikiException

toICal

public java.lang.String toICal(java.lang.String user)
                        throws XWikiException
Throws:
XWikiException

getHTMLCalendarFromICal

public java.lang.String getHTMLCalendarFromICal(CalendarParams calendarParams,
                                                java.lang.String surl,
                                                java.lang.String user)
                                         throws XWikiException,
                                                net.fortuna.ical4j.data.ParserException,
                                                java.io.IOException
Throws:
XWikiException
net.fortuna.ical4j.data.ParserException
java.io.IOException

getHTMLCalendarFromICal

public java.lang.String getHTMLCalendarFromICal(CalendarParams calendarParams,
                                                java.lang.String surl,
                                                java.lang.String user,
                                                java.lang.String username,
                                                java.lang.String password)
                                         throws XWikiException,
                                                net.fortuna.ical4j.data.ParserException,
                                                java.io.IOException
Throws:
XWikiException
net.fortuna.ical4j.data.ParserException
java.io.IOException


Copyright 2003 Ludovic Dubost