groupprovider.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

                                 int&nbsp;numResults)</PRE>
<DL>
<DD>Returns the Collection of all groups in the system.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>startIndex</CODE> - start index in results.<DD><CODE>numResults</CODE> - number of results to return.
<DT><B>Returns:</B><DD>the Collection of all group names given the
      <tt>startIndex</tt> and <tt>numResults</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroupNames(org.xmpp.packet.JID)"><!-- --></A><H3>
getGroupNames</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&gt; <B>getGroupNames</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)</PRE>
<DL>
<DD>Returns the Collection of group names that an entity belongs to.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the JID of the entity.
<DT><B>Returns:</B><DD>the Collection of group names that the user belongs to.</DL>
</DD>
</DL>
<HR>

<A NAME="addMember(java.lang.String, org.xmpp.packet.JID, boolean)"><!-- --></A><H3>
addMember</H3>
<PRE>
void <B>addMember</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;groupName,
               <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user,
               boolean&nbsp;administrator)
               throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></PRE>
<DL>
<DD>Adds an entity to a group (optional operation).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - the group to add the member to<DD><CODE>user</CODE> - the JID of the entity to add<DD><CODE>administrator</CODE> - True if the member is an administrator of the group
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the provider does not
      support the operation.</DL>
</DD>
</DL>
<HR>

<A NAME="updateMember(java.lang.String, org.xmpp.packet.JID, boolean)"><!-- --></A><H3>
updateMember</H3>
<PRE>
void <B>updateMember</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;groupName,
                  <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user,
                  boolean&nbsp;administrator)
                  throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></PRE>
<DL>
<DD>Updates the privileges of an entity in a group.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - the group where the change happened<DD><CODE>user</CODE> - the JID of the entity with new privileges<DD><CODE>administrator</CODE> - True if the member is an administrator of the group
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the provider does not
      support the operation.</DL>
</DD>
</DL>
<HR>

<A NAME="deleteMember(java.lang.String, org.xmpp.packet.JID)"><!-- --></A><H3>
deleteMember</H3>
<PRE>
void <B>deleteMember</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;groupName,
                  <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)
                  throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></PRE>
<DL>
<DD>Deletes an entity from a group (optional operation).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - the group name.<DD><CODE>user</CODE> - the JID of the entity to delete.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the provider does not
      support the operation.</DL>
</DD>
</DL>
<HR>

<A NAME="isReadOnly()"><!-- --></A><H3>
isReadOnly</H3>
<PRE>
boolean <B>isReadOnly</B>()</PRE>
<DL>
<DD>Returns true if this GroupProvider is read-only. When read-only,
 groups can not be created, deleted, or modified.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the user provider is read-only.</DL>
</DD>
</DL>
<HR>

<A NAME="search(java.lang.String)"><!-- --></A><H3>
search</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&gt; <B>search</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;query)</PRE>
<DL>
<DD>Returns the group names that match a search. The search is over group names and
 implicitly uses wildcard matching (although the exact search semantics are left
 up to each provider implementation). For example, a search for "HR" should match
 the groups "HR", "HR Department", and "The HR People".<p>

 Before searching or showing a search UI, use the <A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#isSearchSupported()"><CODE>isSearchSupported()</CODE></A> method
 to ensure that searching is supported.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the search string for group names.
<DT><B>Returns:</B><DD>all groups that match the search.</DL>
</DD>
</DL>
<HR>

<A NAME="search(java.lang.String, int, int)"><!-- --></A><H3>
search</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&gt; <B>search</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;query,
                          int&nbsp;startIndex,
                          int&nbsp;numResults)</PRE>
<DL>
<DD>Returns the group names that match a search given a start index and desired number of results.
 The search is over group names and implicitly uses wildcard matching (although the
 exact search semantics are left up to each provider implementation). For example, a
 search for "HR" should match the groups "HR", "HR Department", and "The HR People".<p>

 Before searching or showing a search UI, use the <A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#isSearchSupported()"><CODE>isSearchSupported()</CODE></A> method
 to ensure that searching is supported.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the search string for group names.<DD><CODE>startIndex</CODE> - start index in results.<DD><CODE>numResults</CODE> - number of results to return.
<DT><B>Returns:</B><DD>all groups that match the search.</DL>
</DD>
</DL>
<HR>

<A NAME="isSearchSupported()"><!-- --></A><H3>
isSearchSupported</H3>
<PRE>
boolean <B>isSearchSupported</B>()</PRE>
<DL>
<DD>Returns true if group searching is supported by the provider.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if searching is supported.</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=2 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>&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>
<b>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/group/GroupNotFoundException.html" title="class in org.jivesoftware.openfire.group"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/group/JDBCGroupProvider.html" title="class in org.jivesoftware.openfire.group"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/group/GroupProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="GroupProvider.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2008 Jive Software.</i>
</BODY>
</HTML>