eventlist.html

J2ME手机编程规范JSR-75文档

STARTING</H3>
<PRE>
public static final int <B>STARTING</B></PRE>
<DL>
<DD>Constant representing a search type for Events based on the event
 occurrence's specific start date/time.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.EventList.STARTING">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ENDING"><!-- --></A><H3>
ENDING</H3>
<PRE>
public static final int <B>ENDING</B></PRE>
<DL>
<DD>Constant representing a search type for Events based on the event
 occurrence's specific end date/time.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.EventList.ENDING">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="OCCURRING"><!-- --></A><H3>
OCCURRING</H3>
<PRE>
public static final int <B>OCCURRING</B></PRE>
<DL>
<DD>Constant representing a search type for Events based on any occurrence
 of an event during a time period.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.EventList.OCCURRING">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->


<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="createEvent()"><!-- --></A><H3>
createEvent</H3>
<PRE>
public <A HREF="../../../javax/microedition/pim/Event.html">Event</A> <B>createEvent</B>()</PRE>
<DL>
<DD>Factory method to create an Event for this event list.   The Event
 is empty upon creation with none of its fields containing any data (i.e. a
 call to the method <code>Event.getFields()</code> will return an array
 of zero length). Even though it is initially empty, the Event is
 <i>capable</i> of containing data for exactly those fields that this list
 supports.
 Note that creation of the Event does not add the Event to the list
 from which the item was created; a specific call to
 <code>PIMItem.commit()</code> must be made to commit the item and
 its data to the list.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a new, empty Event object associated with this list.  However,
           the Event is still not persistent in the list until a call to
           <code>PIMItem.commit()</code> for the Event is made.</DL>
</DD>
</DL>
<HR>

<A NAME="importEvent(javax.microedition.pim.Event)"><!-- --></A><H3>
importEvent</H3>
<PRE>
public <A HREF="../../../javax/microedition/pim/Event.html">Event</A> <B>importEvent</B>(<A HREF="../../../javax/microedition/pim/Event.html">Event</A>&nbsp;item)</PRE>
<DL>
<DD>Imports the given Event into this list by making a new Event for the
 list and filling its information with as much information as it can from
 the provided Event.  If the input Event is already in the list,
 a new Event is still created with information similar to the input item
 (but not necessarily identical). </P>
 <P>Note that not all data from the input Event may be supported in the
 new Event due to field restrictions for the list instance.  In this
 case, data fields not supported are not transferred to the new Event
 object. </P>
 <P>Also note that creation of the Event does not add the Event
 to this list; a specific call to <code>PIMItem.commit()</code> must be
 made to commit the item and its data to the list. </P>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>item</CODE> - the Event to import into the list.
<DT><B>Returns:</B><DD>a newly created Event.
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - If the <code>item</code> is
           <code>null</code>.</DL>
</DD>
</DL>
<HR>

<A NAME="removeEvent(javax.microedition.pim.Event)"><!-- --></A><H3>
removeEvent</H3>
<PRE>
public void <B>removeEvent</B>(<A HREF="../../../javax/microedition/pim/Event.html">Event</A>&nbsp;item)
                 throws <A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></PRE>
<DL>
<DD>Removes a specific Event from the list.  The item must already
 exist in the list for this method to succeed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>item</CODE> - the Event to be removed from the list.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></CODE> - If an error occurs deleting the item
           or the list is no longer accessible or closed.
<DD><CODE>java.lang.NullPointerException</CODE> - If <code>item</code> is
           <code>null</code>.
<DD><CODE>java.lang.SecurityException</CODE> - if the application is not given
           permission to write to the Event list or the list is opened
           READ_ONLY.</DL>
</DD>
</DL>
<HR>

<A NAME="items(int, long, long, boolean)"><!-- --></A><H3>
items</H3>
<PRE>
public java.util.Enumeration <B>items</B>(int&nbsp;searchType,
                                   long&nbsp;startDate,
                                   long&nbsp;endDate,
                                   boolean&nbsp;initialEventOnly)
                            throws <A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></PRE>
<DL>
<DD>Return an enumeration of all the Events where at least one of the Event's
 occurrences falls in the specified range from startDate to
 endDate inclusive. The search type specified determines the criteria for
 matching an event occurrence; <code>STARTING</code> searches for events
 starting between startDate and endDate, <code>ENDING</code> searches for
 events ending between startDate and endDate, and <code>OCCURRING</code>
 searches for events that have an part of the event occurring during the
 period specified by startDate and endDate.  The returned Events are
 sorted in ascending order by the start date/time of the event.  An Event
 will be returned by the Enumeration only once if the event reoccurs more
 than once during the specified time interval.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>searchType</CODE> - the criteria used to determine which Events are
          returned. Must be <A HREF="../../../javax/microedition/pim/EventList.html#STARTING"><CODE>STARTING</CODE></A>, <A HREF="../../../javax/microedition/pim/EventList.html#ENDING"><CODE>ENDING</CODE></A>, or
          <A HREF="../../../javax/microedition/pim/EventList.html#OCCURRING"><CODE>OCCURRING</CODE></A>.<DD><CODE>startDate</CODE> - the inclusive start date to begin looking for event
          occurrences on or after this date, returned in milliseconds
          since the epoch (00:00:00 GMT, January 1, 1970)<DD><CODE>endDate</CODE> - the inclusive stop date to end looking for events beyond
          this date, returned in  milliseconds since the epoch
          (00:00:00 GMT, January 1, 1970)<DD><CODE>initialEventOnly</CODE> - true indicates only search based on an Event's
          START and END values and do not calculate repeating occurrences
          of the event.  False indicates repeating occurrences of
          an Event are included during the search.
<DT><B>Returns:</B><DD>an enumeration of all the Events with an occurrence
          between startDate and endDate
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if searchType is not
          <A HREF="../../../javax/microedition/pim/EventList.html#STARTING"><CODE>STARTING</CODE></A>, <A HREF="../../../javax/microedition/pim/EventList.html#ENDING"><CODE>ENDING</CODE></A>, or <A HREF="../../../javax/microedition/pim/EventList.html#OCCURRING"><CODE>OCCURRING</CODE></A>.
<DD><CODE><A HREF="../../../javax/microedition/pim/PIMException.html">PIMException</A></CODE> - If the operation is unsupported, an error occurs,
          or the list is no longer accessible or closed.
<DD><CODE>java.lang.SecurityException</CODE> - if the application is not given
          permission to read the Event list or the list is opened
          WRITE_ONLY.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Proposed Final Draft<br>Rev. 0.24</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../javax/microedition/pim/Event.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../javax/microedition/pim/PIMItem.html"><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>  &nbsp;
&nbsp;<A HREF="EventList.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<SCRIPT>
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<font size=-1>Copyright &copy; 2002-2003 PalmSource, Inc.  All Rights Reserved.<br>Java is a trademark of Sun Microsystems, Inc.</font>
</BODY>
</HTML>