diff options
| author | Paul Buetow <paul@buetow.org> | 2009-02-08 01:37:25 +0000 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2009-02-08 01:37:25 +0000 |
| commit | 69f0e6b0bf0dc0a6c6fe8ccf17c74960697ca10c (patch) | |
| tree | 4b99d266e90f2ac93e46b499b6e02c6dd4bcae18 /javadoc/shared/remotecall/ClientRequest.html | |
1.0 releasedv0.1
Diffstat (limited to 'javadoc/shared/remotecall/ClientRequest.html')
| -rw-r--r-- | javadoc/shared/remotecall/ClientRequest.html | 794 |
1 files changed, 794 insertions, 0 deletions
diff --git a/javadoc/shared/remotecall/ClientRequest.html b/javadoc/shared/remotecall/ClientRequest.html new file mode 100644 index 0000000..6d6e2de --- /dev/null +++ b/javadoc/shared/remotecall/ClientRequest.html @@ -0,0 +1,794 @@ +<!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:48 CEST 2006 --> +<TITLE> +ClientRequest +</TITLE> + +<META NAME="keywords" CONTENT="shared.remotecall.ClientRequest class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="ClientRequest"; +} +</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/ClientRequest.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="../../shared/remotecall/RemoteCall.html" title="class in shared.remotecall"><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="ClientRequest.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <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"> +shared.remotecall</FONT> +<BR> +Class ClientRequest</H2> +<PRE> +java.lang.Object + <IMG SRC="../../resources/inherit.gif" ALT="extended by"><A HREF="../../shared/remotecall/RemoteCall.html" title="class in shared.remotecall">shared.remotecall.RemoteCall</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by"><B>shared.remotecall.ClientRequest</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<HR> +<DL> +<DT>public final class <B>ClientRequest</B><DT>extends <A HREF="../../shared/remotecall/RemoteCall.html" title="class in shared.remotecall">RemoteCall</A><DT>implements java.io.Serializable</DL> + +<P> +An object of this class is sent from the calendar client to the calendar server each time + a request is made. This class encapsulates all the needed information so that the server can + response with a serialized server response object. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>buetow</DD> +<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#shared.remotecall.ClientRequest">Serialized Form</A></DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#ADD_EVENT">ADD_EVENT</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#DELETE_EVENT">DELETE_EVENT</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#FLUSH_DATABASE">FLUSH_DATABASE</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#MODIFY_EVENT">MODIFY_EVENT</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#RELOAD_DATABASE">RELOAD_DATABASE</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#REQUEST_ALL_EVENTS">REQUEST_ALL_EVENTS</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#REQUEST_EVENTS">REQUEST_EVENTS</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#SHUTDOWN_SERVER">SHUTDOWN_SERVER</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ======== 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="../../shared/remotecall/ClientRequest.html#ClientRequest()">ClientRequest</A></B>()</CODE> + +<BR> + Simple constructor, creates a client request object requesting events up + from the current date.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#ClientRequest(int)">ClientRequest</A></B>(int iAction)</CODE> + +<BR> + Simple constructor, creates a client request object requesting events up + from the current date.</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> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#actionIs(int)">actionIs</A></B>(int iAction)</CODE> + +<BR> + This method is needed by the clanedar server to get the type of action requested.</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="../../shared/remotecall/ClientRequest.html#getEvent()">getEvent</A></B>()</CODE> + +<BR> + This method returns the event object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#getNumEventsToRequest()">getNumEventsToRequest</A></B>()</CODE> + +<BR> + This method returns the maximum number of events the client wants to request.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#match(shared.CalendarEvent)">match</A></B>(<A HREF="../../shared/CalendarEvent.html" title="class in shared">CalendarEvent</A> calendarEvent)</CODE> + +<BR> + Checks if a specific calendar event matches this client request.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#requestsNewEvents()">requestsNewEvents</A></B>()</CODE> + +<BR> + This method is needed by the calendar server to get the type of action requested.</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="../../shared/remotecall/ClientRequest.html#setDateRange(java.util.Date, java.util.Date)">setDateRange</A></B>(java.util.Date dateRangeFrom, + java.util.Date dateRangeTo)</CODE> + +<BR> + This method sets the date range to 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="../../shared/remotecall/ClientRequest.html#setEvent(shared.CalendarEvent)">setEvent</A></B>(<A HREF="../../shared/CalendarEvent.html" title="class in shared">CalendarEvent</A> event)</CODE> + +<BR> + This method sets a calendar event object to be transfered to the calendar server because the event has been modified.</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="../../shared/remotecall/ClientRequest.html#setMainRegexp(boolean)">setMainRegexp</A></B>(boolean bMainRegexp)</CODE> + +<BR> + This method sets if the client contains a regexp from the main session window.</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="../../shared/remotecall/ClientRequest.html#setNumEventsToRequest(int)">setNumEventsToRequest</A></B>(int iNumEvents)</CODE> + +<BR> + With this method the client can define the maximum number of events to 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="../../shared/remotecall/ClientRequest.html#setRegexpAll(java.lang.String)">setRegexpAll</A></B>(java.lang.String sRegexp)</CODE> + +<BR> + This method compiles a specific pattern object to match with on the server part after serialization.</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="../../shared/remotecall/ClientRequest.html#setRegexpCategory(java.lang.String)">setRegexpCategory</A></B>(java.lang.String sRegexp)</CODE> + +<BR> + This method compiles a specific pattern object to match with on the server part after serialization.</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="../../shared/remotecall/ClientRequest.html#setRegexpDate(java.lang.String)">setRegexpDate</A></B>(java.lang.String sRegexp)</CODE> + +<BR> + This method compiles a specific pattern object to match with on the server part after serialization.</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="../../shared/remotecall/ClientRequest.html#setRegexpDescription(java.lang.String)">setRegexpDescription</A></B>(java.lang.String sRegexp)</CODE> + +<BR> + This method compiles a specific pattern object to match with on the server part after serialization.</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="../../shared/remotecall/ClientRequest.html#setRegexpPlace(java.lang.String)">setRegexpPlace</A></B>(java.lang.String sRegexp)</CODE> + +<BR> + This method compiles a specific pattern object to match with on the server part after serialization.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../shared/remotecall/ClientRequest.html#toString()">toString</A></B>()</CODE> + +<BR> + This method returns a representation the object as a string.</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, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="REQUEST_EVENTS"><!-- --></A><H3> +REQUEST_EVENTS</H3> +<PRE> +public static final int <B>REQUEST_EVENTS</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#shared.remotecall.ClientRequest.REQUEST_EVENTS">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="REQUEST_ALL_EVENTS"><!-- --></A><H3> +REQUEST_ALL_EVENTS</H3> +<PRE> +public static final int <B>REQUEST_ALL_EVENTS</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#shared.remotecall.ClientRequest.REQUEST_ALL_EVENTS">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="MODIFY_EVENT"><!-- --></A><H3> +MODIFY_EVENT</H3> +<PRE> +public static final int <B>MODIFY_EVENT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#shared.remotecall.ClientRequest.MODIFY_EVENT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="DELETE_EVENT"><!-- --></A><H3> +DELETE_EVENT</H3> +<PRE> +public static final int <B>DELETE_EVENT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#shared.remotecall.ClientRequest.DELETE_EVENT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="ADD_EVENT"><!-- --></A><H3> +ADD_EVENT</H3> +<PRE> +public static final int <B>ADD_EVENT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#shared.remotecall.ClientRequest.ADD_EVENT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="RELOAD_DATABASE"><!-- --></A><H3> +RELOAD_DATABASE</H3> +<PRE> +public static final int <B>RELOAD_DATABASE</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#shared.remotecall.ClientRequest.RELOAD_DATABASE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="FLUSH_DATABASE"><!-- --></A><H3> +FLUSH_DATABASE</H3> +<PRE> +public static final int <B>FLUSH_DATABASE</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#shared.remotecall.ClientRequest.FLUSH_DATABASE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="SHUTDOWN_SERVER"><!-- --></A><H3> +SHUTDOWN_SERVER</H3> +<PRE> +public static final int <B>SHUTDOWN_SERVER</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#shared.remotecall.ClientRequest.SHUTDOWN_SERVER">Constant Field Values</A></DL> +</DL> + +<!-- ========= 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="ClientRequest()"><!-- --></A><H3> +ClientRequest</H3> +<PRE> +public <B>ClientRequest</B>()</PRE> +<DL> +<DD>Simple constructor, creates a client request object requesting events up + from the current date. +<P> +</DL> +<HR> + +<A NAME="ClientRequest(int)"><!-- --></A><H3> +ClientRequest</H3> +<PRE> +public <B>ClientRequest</B>(int iAction)</PRE> +<DL> +<DD>Simple constructor, creates a client request object requesting events up + from the current date. +<P> +<DT><B>Parameters:</B><DD><CODE>iAction</CODE> - Specifies the request type of this request.</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="actionIs(int)"><!-- --></A><H3> +actionIs</H3> +<PRE> +public boolean <B>actionIs</B>(int iAction)</PRE> +<DL> +<DD>This method is needed by the clanedar server to get the type of action requested. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>iAction</CODE> - Specifies the action to test against. +<DT><B>Returns:</B><DD>Returns true if the specified action ID matches with the action ID of this request object.</DL> +</DD> +</DL> +<HR> + +<A NAME="requestsNewEvents()"><!-- --></A><H3> +requestsNewEvents</H3> +<PRE> +public boolean <B>requestsNewEvents</B>()</PRE> +<DL> +<DD>This method is needed by the calendar server to get the type of action requested. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns true if this object requests new events from the server.</DL> +</DD> +</DL> +<HR> + +<A NAME="setDateRange(java.util.Date, java.util.Date)"><!-- --></A><H3> +setDateRange</H3> +<PRE> +public void <B>setDateRange</B>(java.util.Date dateRangeFrom, + java.util.Date dateRangeTo)</PRE> +<DL> +<DD>This method sets the date range to request. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>dateRangeFrom</CODE> - Specifies the beginning date.<DD><CODE>dateRangeTo</CODE> - Specifies the ending date.</DL> +</DD> +</DL> +<HR> + +<A NAME="setEvent(shared.CalendarEvent)"><!-- --></A><H3> +setEvent</H3> +<PRE> +public void <B>setEvent</B>(<A HREF="../../shared/CalendarEvent.html" title="class in shared">CalendarEvent</A> event)</PRE> +<DL> +<DD>This method sets a calendar event object to be transfered to the calendar server because the event has been modified. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>event</CODE> - Specifies an event to be transfered to the calendar server.</DL> +</DD> +</DL> +<HR> + +<A NAME="getEvent()"><!-- --></A><H3> +getEvent</H3> +<PRE> +public <A HREF="../../shared/CalendarEvent.html" title="class in shared">CalendarEvent</A> <B>getEvent</B>()</PRE> +<DL> +<DD>This method returns the event object. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the calendar event which is stored inside this client request.</DL> +</DD> +</DL> +<HR> + +<A NAME="setNumEventsToRequest(int)"><!-- --></A><H3> +setNumEventsToRequest</H3> +<PRE> +public void <B>setNumEventsToRequest</B>(int iNumEvents)</PRE> +<DL> +<DD>With this method the client can define the maximum number of events to request. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>iNumEvents</CODE> - Specifies the maximum number of events to request.</DL> +</DD> +</DL> +<HR> + +<A NAME="getNumEventsToRequest()"><!-- --></A><H3> +getNumEventsToRequest</H3> +<PRE> +public int <B>getNumEventsToRequest</B>()</PRE> +<DL> +<DD>This method returns the maximum number of events the client wants to request. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the maximum number of events the client wants to request.</DL> +</DD> +</DL> +<HR> + +<A NAME="setMainRegexp(boolean)"><!-- --></A><H3> +setMainRegexp</H3> +<PRE> +public void <B>setMainRegexp</B>(boolean bMainRegexp)</PRE> +<DL> +<DD>This method sets if the client contains a regexp from the main session window. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>bMainRegexp</CODE> - Set to true if the user used the main regexp field of the main GUI window.</DL> +</DD> +</DL> +<HR> + +<A NAME="setRegexpAll(java.lang.String)"><!-- --></A><H3> +setRegexpAll</H3> +<PRE> +public void <B>setRegexpAll</B>(java.lang.String sRegexp)</PRE> +<DL> +<DD>This method compiles a specific pattern object to match with on the server part after serialization. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sRegexp</CODE> - Compiles a Pattern object with sRegexp as the regular expression.</DL> +</DD> +</DL> +<HR> + +<A NAME="setRegexpCategory(java.lang.String)"><!-- --></A><H3> +setRegexpCategory</H3> +<PRE> +public void <B>setRegexpCategory</B>(java.lang.String sRegexp)</PRE> +<DL> +<DD>This method compiles a specific pattern object to match with on the server part after serialization. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sRegexp</CODE> - Compiles a Pattern object with sRegexp as the regular expression.</DL> +</DD> +</DL> +<HR> + +<A NAME="setRegexpDescription(java.lang.String)"><!-- --></A><H3> +setRegexpDescription</H3> +<PRE> +public void <B>setRegexpDescription</B>(java.lang.String sRegexp)</PRE> +<DL> +<DD>This method compiles a specific pattern object to match with on the server part after serialization. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sRegexp</CODE> - Compiles a Pattern object with sRegexp as the regular expression.</DL> +</DD> +</DL> +<HR> + +<A NAME="setRegexpPlace(java.lang.String)"><!-- --></A><H3> +setRegexpPlace</H3> +<PRE> +public void <B>setRegexpPlace</B>(java.lang.String sRegexp)</PRE> +<DL> +<DD>This method compiles a specific pattern object to match with on the server part after serialization. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sRegexp</CODE> - Compiles a Pattern object with sRegexp as the regular expression.</DL> +</DD> +</DL> +<HR> + +<A NAME="setRegexpDate(java.lang.String)"><!-- --></A><H3> +setRegexpDate</H3> +<PRE> +public void <B>setRegexpDate</B>(java.lang.String sRegexp)</PRE> +<DL> +<DD>This method compiles a specific pattern object to match with on the server part after serialization. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sRegexp</CODE> - Compiles a Pattern object with sRegexp as the regular expression.</DL> +</DD> +</DL> +<HR> + +<A NAME="match(shared.CalendarEvent)"><!-- --></A><H3> +match</H3> +<PRE> +public boolean <B>match</B>(<A HREF="../../shared/CalendarEvent.html" title="class in shared">CalendarEvent</A> calendarEvent)</PRE> +<DL> +<DD>Checks if a specific calendar event matches this client request. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>calendarEvent</CODE> - Specifies the event to match against. +<DT><B>Returns:</B><DD>Returns true if the given event matched. Else, false will be returned.</DL> +</DD> +</DL> +<HR> + +<A NAME="toString()"><!-- --></A><H3> +toString</H3> +<PRE> +public java.lang.String <B>toString</B>()</PRE> +<DL> +<DD>This method returns a representation the object as a string. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the object represented as a string.</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/ClientRequest.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="../../shared/remotecall/RemoteCall.html" title="class in shared.remotecall"><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="ClientRequest.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <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> |