diff options
Diffstat (limited to 'doc/server/CalendarDatabase.html')
| -rw-r--r-- | doc/server/CalendarDatabase.html | 439 |
1 files changed, 0 insertions, 439 deletions
diff --git a/doc/server/CalendarDatabase.html b/doc/server/CalendarDatabase.html deleted file mode 100644 index 81605d6..0000000 --- a/doc/server/CalendarDatabase.html +++ /dev/null @@ -1,439 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.4.2-p8) on Sat Apr 29 14:43:47 CEST 2006 --> -<TITLE> -CalendarDatabase -</TITLE> - -<META NAME="keywords" CONTENT="server.CalendarDatabase class"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - parent.document.title="CalendarDatabase"; -} -</SCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> - - -<!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CalendarDatabase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - PREV CLASS - <A HREF="../server/CalendarFormatParser.html" title="class in server"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../index.html" target="_top"><B>FRAMES</B></A> - <A HREF="CalendarDatabase.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> -<!-- ========= END OF TOP NAVBAR ========= --> - -<HR> -<!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -server</FONT> -<BR> -Class CalendarDatabase</H2> -<PRE> -java.lang.Object - <IMG SRC="../resources/inherit.gif" ALT="extended by"><B>server.CalendarDatabase</B> -</PRE> -<HR> -<DL> -<DT>public final class <B>CalendarDatabase</B><DT>extends java.lang.Object</DL> - -<P> -A object of this class encapsulates the whole calendar database on the server side. - This class is used for getting/modifying and adding/removing of calendar events. -<P> - -<P> -<DL> -<DT><B>Author:</B></DT> - <DD>buetow</DD> -</DL> -<HR> - -<P> -<!-- ======== NESTED CLASS SUMMARY ======== --> - - -<!-- =========== FIELD SUMMARY =========== --> - - -<!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TD COLSPAN=2><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../server/CalendarDatabase.html#CalendarDatabase(java.util.Vector)">CalendarDatabase</A></B>(java.util.Vector vecCategories)</CODE> - -<BR> - Simple constructur.</TD> -</TR> -</TABLE> - -<!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TD COLSPAN=2><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../server/CalendarDatabase.html#addEvent(shared.remotecall.ClientRequest)">addEvent</A></B>(<A HREF="../shared/remotecall/ClientRequest.html" title="class in shared.remotecall">ClientRequest</A> clientRequest)</CODE> - -<BR> - This method adds a calendar event to the calendar database.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../server/CalendarDatabase.html#deleteEvent(shared.remotecall.ClientRequest)">deleteEvent</A></B>(<A HREF="../shared/remotecall/ClientRequest.html" title="class in shared.remotecall">ClientRequest</A> clientRequest)</CODE> - -<BR> - This method deletes a calendar event of the calendar database.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../server/CalendarDatabase.html#flush()">flush</A></B>()</CODE> - -<BR> - This method flushes all the changed calendar categories of the calendar database to the filesystem.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.util.Vector</CODE></FONT></TD> -<TD><CODE><B><A HREF="../server/CalendarDatabase.html#getAllEvents()">getAllEvents</A></B>()</CODE> - -<BR> - This method returns a Vector of all available calendar events.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.util.Vector</CODE></FONT></TD> -<TD><CODE><B><A HREF="../server/CalendarDatabase.html#getCategories()">getCategories</A></B>()</CODE> - -<BR> - Gets all calendar categories.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../shared/CalendarCategory.html" title="class in shared">CalendarCategory</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../server/CalendarDatabase.html#getCategory(java.lang.String)">getCategory</A></B>(java.lang.String sCategoryName)</CODE> - -<BR> - Returns a specific calendar category using fast hash lookup.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../shared/CalendarEvent.html" title="class in shared">CalendarEvent</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../server/CalendarDatabase.html#getEvent(int)">getEvent</A></B>(int iEventID)</CODE> - -<BR> - Returns a specific calendar event using fast hash lookup.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.util.Vector</CODE></FONT></TD> -<TD><CODE><B><A HREF="../server/CalendarDatabase.html#getMatchingEvents(shared.remotecall.ClientRequest)">getMatchingEvents</A></B>(<A HREF="../shared/remotecall/ClientRequest.html" title="class in shared.remotecall">ClientRequest</A> clientRequest)</CODE> - -<BR> - This method looks for all calendar events which match the a given client request.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../server/CalendarDatabase.html#modifyEvent(shared.remotecall.ClientRequest)">modifyEvent</A></B>(<A HREF="../shared/remotecall/ClientRequest.html" title="class in shared.remotecall">ClientRequest</A> clientRequest)</CODE> - -<BR> - This method modifies an calendar event of the calendar database.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TD><B>Methods inherited from class java.lang.Object</B></TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> -</TR> -</TABLE> - -<P> - -<!-- ============ FIELD DETAIL =========== --> - - -<!-- ========= CONSTRUCTOR DETAIL ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TD COLSPAN=1><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TD> -</TR> -</TABLE> - -<A NAME="CalendarDatabase(java.util.Vector)"><!-- --></A><H3> -CalendarDatabase</H3> -<PRE> -public <B>CalendarDatabase</B>(java.util.Vector vecCategories)</PRE> -<DL> -<DD>Simple constructur. Creates a calendar database. -<P> -<DT><B>Parameters:</B><DD><CODE>vecCategories</CODE> - Specifies the vector of CalendarCategory objects for initial database content.</DL> - -<!-- ============ METHOD DETAIL ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TD COLSPAN=1><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TD> -</TR> -</TABLE> - -<A NAME="getEvent(int)"><!-- --></A><H3> -getEvent</H3> -<PRE> -public <A HREF="../shared/CalendarEvent.html" title="class in shared">CalendarEvent</A> <B>getEvent</B>(int iEventID)</PRE> -<DL> -<DD>Returns a specific calendar event using fast hash lookup. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>iEventID</CODE> - Specifies the ID of the calendar event to lookup. -<DT><B>Returns:</B><DD>Returns the requested calendar event.</DL> -</DD> -</DL> -<HR> - -<A NAME="getCategory(java.lang.String)"><!-- --></A><H3> -getCategory</H3> -<PRE> -public <A HREF="../shared/CalendarCategory.html" title="class in shared">CalendarCategory</A> <B>getCategory</B>(java.lang.String sCategoryName)</PRE> -<DL> -<DD>Returns a specific calendar category using fast hash lookup. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>sCategoryName</CODE> - Specifies the name of the calendar category to lookup. -<DT><B>Returns:</B><DD>Returns the requested calendar category.</DL> -</DD> -</DL> -<HR> - -<A NAME="getCategories()"><!-- --></A><H3> -getCategories</H3> -<PRE> -public java.util.Vector <B>getCategories</B>()</PRE> -<DL> -<DD>Gets all calendar categories. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>Returns a Vector of all available CalendarCategory objects.</DL> -</DD> -</DL> -<HR> - -<A NAME="getAllEvents()"><!-- --></A><H3> -getAllEvents</H3> -<PRE> -public java.util.Vector <B>getAllEvents</B>()</PRE> -<DL> -<DD>This method returns a Vector of all available calendar events. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>Returns all available CalendarEvent objects of the database.</DL> -</DD> -</DL> -<HR> - -<A NAME="getMatchingEvents(shared.remotecall.ClientRequest)"><!-- --></A><H3> -getMatchingEvents</H3> -<PRE> -public java.util.Vector <B>getMatchingEvents</B>(<A HREF="../shared/remotecall/ClientRequest.html" title="class in shared.remotecall">ClientRequest</A> clientRequest)</PRE> -<DL> -<DD>This method looks for all calendar events which match the a given client request. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>clientRequest</CODE> - Specifies the client request sent by the calendar client. -<DT><B>Returns:</B><DD>Returns a Vector of all matching CalendarEvent objects.</DL> -</DD> -</DL> -<HR> - -<A NAME="addEvent(shared.remotecall.ClientRequest)"><!-- --></A><H3> -addEvent</H3> -<PRE> -public void <B>addEvent</B>(<A HREF="../shared/remotecall/ClientRequest.html" title="class in shared.remotecall">ClientRequest</A> clientRequest)</PRE> -<DL> -<DD>This method adds a calendar event to the calendar database. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>clientRequest</CODE> - Specifies the client request sent by the netcalendar client. Its containing the new event to add.</DL> -</DD> -</DL> -<HR> - -<A NAME="modifyEvent(shared.remotecall.ClientRequest)"><!-- --></A><H3> -modifyEvent</H3> -<PRE> -public void <B>modifyEvent</B>(<A HREF="../shared/remotecall/ClientRequest.html" title="class in shared.remotecall">ClientRequest</A> clientRequest)</PRE> -<DL> -<DD>This method modifies an calendar event of the calendar database. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>clientRequest</CODE> - Specifies the client request sent by the calendar client.</DL> -</DD> -</DL> -<HR> - -<A NAME="deleteEvent(shared.remotecall.ClientRequest)"><!-- --></A><H3> -deleteEvent</H3> -<PRE> -public void <B>deleteEvent</B>(<A HREF="../shared/remotecall/ClientRequest.html" title="class in shared.remotecall">ClientRequest</A> clientRequest)</PRE> -<DL> -<DD>This method deletes a calendar event of the calendar database. If the specified calendar event doesnt - exist eny more, nothing will be changed. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>clientRequest</CODE> - Specifies the client request sent by the netcalendar client.</DL> -</DD> -</DL> -<HR> - -<A NAME="flush()"><!-- --></A><H3> -flush</H3> -<PRE> -public void <B>flush</B>()</PRE> -<DL> -<DD>This method flushes all the changed calendar categories of the calendar database to the filesystem. -<P> -<DD><DL> -</DL> -</DD> -</DL> -<!-- ========= END OF CLASS DATA ========= --> -<HR> - - -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CalendarDatabase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - PREV CLASS - <A HREF="../server/CalendarFormatParser.html" title="class in server"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../index.html" target="_top"><B>FRAMES</B></A> - <A HREF="CalendarDatabase.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> -<!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> - -</BODY> -</HTML> |