groupmanager.html

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

<HR>

<A NAME="getGroups(int, int)"><!-- --></A><H3>
getGroups</H3>
<PRE>
public <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="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&gt; <B>getGroups</B>(int&nbsp;startIndex,
                                   int&nbsp;numResults)</PRE>
<DL>
<DD>Returns all groups given a start index and desired number of results. This is
 useful to support pagination in a GUI where you may only want to display a certain
 number of results per page. It is possible that the number of results returned will
 be less than that specified by numResults if numResults is greater than the number
 of records left in the system to display.
<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>an Iterator for all groups in the specified range.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroups(org.jivesoftware.openfire.user.User)"><!-- --></A><H3>
getGroups</H3>
<PRE>
public <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="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&gt; <B>getGroups</B>(<A HREF="../../../../org/jivesoftware/openfire/user/User.html" title="class in org.jivesoftware.openfire.user">User</A>&nbsp;user)</PRE>
<DL>
<DD>Returns an iterator for all groups that the User is a member of.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the user.
<DT><B>Returns:</B><DD>all groups the user belongs to.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroups(org.xmpp.packet.JID)"><!-- --></A><H3>
getGroups</H3>
<PRE>
public <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="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&gt; <B>getGroups</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)</PRE>
<DL>
<DD>Returns an iterator for all groups that the entity with the specified JID is a member of.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the JID of the entity to get a list of groups for.
<DT><B>Returns:</B><DD>all groups that an entity belongs to.</DL>
</DD>
</DL>
<HR>

<A NAME="isReadOnly()"><!-- --></A><H3>
isReadOnly</H3>
<PRE>
public boolean <B>isReadOnly</B>()</PRE>
<DL>
<DD>Returns true if groups are read-only.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if groups are read-only.</DL>
</DD>
</DL>
<HR>

<A NAME="isPropertyReadOnly()"><!-- --></A><H3>
isPropertyReadOnly</H3>
<PRE>
public boolean <B>isPropertyReadOnly</B>()</PRE>
<DL>
<DD>Returns true if properties of groups are read only.
 They are read only if Clearspace is the group provider.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if properties of groups are read only.</DL>
</DD>
</DL>
<HR>

<A NAME="isSearchSupported()"><!-- --></A><H3>
isSearchSupported</H3>
<PRE>
public boolean <B>isSearchSupported</B>()</PRE>
<DL>
<DD>Returns true if searching for groups is supported.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if searching for groups are supported.</DL>
</DD>
</DL>
<HR>

<A NAME="search(java.lang.String)"><!-- --></A><H3>
search</H3>
<PRE>
public <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="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</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 groups that match the 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/GroupManager.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>
public <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="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</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 groups that match the 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/GroupManager.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="getProvider()"><!-- --></A><H3>
getProvider</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A> <B>getProvider</B>()</PRE>
<DL>
<DD>Returns the configured group provider. Note that this method has special access
 privileges since only a few certain classes need to access the provider directly.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the group provider.</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/GroupCollection.html" title="class in org.jivesoftware.openfire.group"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/group/GroupNotFoundException.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/GroupManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="GroupManager.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>