clearspacegroupprovider.html

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

<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#deleteGroup(java.lang.String)">deleteGroup</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the group 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="getGroup(java.lang.String)"><!-- --></A><H3>
getGroup</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A> <B>getGroup</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;name)
               throws <A HREF="../../../../org/jivesoftware/openfire/group/GroupNotFoundException.html" title="class in org.jivesoftware.openfire.group">GroupNotFoundException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getGroup(java.lang.String)">GroupProvider</A></CODE></B></DD>
<DD>Returns a group based on it's name.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getGroup(java.lang.String)">getGroup</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the group.
<DT><B>Returns:</B><DD>the group with the given name.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupNotFoundException.html" title="class in org.jivesoftware.openfire.group">GroupNotFoundException</A></CODE> - If no group with that ID could be found</DL>
</DD>
</DL>
<HR>

<A NAME="setName(java.lang.String, java.lang.String)"><!-- --></A><H3>
setName</H3>
<PRE>
public void <B>setName</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;oldName,
                    <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;newName)
             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>,
                    <A HREF="../../../../org/jivesoftware/openfire/group/GroupAlreadyExistsException.html" title="class in org.jivesoftware.openfire.group">GroupAlreadyExistsException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#setName(java.lang.String, java.lang.String)">GroupProvider</A></CODE></B></DD>
<DD>Sets the name of a group to a new name.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#setName(java.lang.String, java.lang.String)">setName</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>oldName</CODE> - the current name of the group.<DD><CODE>newName</CODE> - the desired new name 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.
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupAlreadyExistsException.html" title="class in org.jivesoftware.openfire.group">GroupAlreadyExistsException</A></CODE> - if a group with the same name already
      exists.</DL>
</DD>
</DL>
<HR>

<A NAME="setDescription(java.lang.String, java.lang.String)"><!-- --></A><H3>
setDescription</H3>
<PRE>
public void <B>setDescription</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;name,
                           <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;description)
                    throws <A HREF="../../../../org/jivesoftware/openfire/group/GroupNotFoundException.html" title="class in org.jivesoftware.openfire.group">GroupNotFoundException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#setDescription(java.lang.String, java.lang.String)">GroupProvider</A></CODE></B></DD>
<DD>Updates the group's description.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#setDescription(java.lang.String, java.lang.String)">setDescription</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the group name.<DD><CODE>description</CODE> - the group description.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupNotFoundException.html" title="class in org.jivesoftware.openfire.group">GroupNotFoundException</A></CODE> - if no existing group could be found to update.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroupCount()"><!-- --></A><H3>
getGroupCount</H3>
<PRE>
public int <B>getGroupCount</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getGroupCount()">GroupProvider</A></CODE></B></DD>
<DD>Returns the number of groups in the system.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getGroupCount()">getGroupCount</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the number of groups in the system.</DL>
</DD>
</DL>
<HR>

<A NAME="getSharedGroupsNames()"><!-- --></A><H3>
getSharedGroupsNames</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="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>getSharedGroupsNames</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getSharedGroupsNames()">GroupProvider</A></CODE></B></DD>
<DD>Returns an unmodifiable Collection of all shared groups in the system.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getSharedGroupsNames()">getSharedGroupsNames</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>unmodifiable Collection of all shared groups in the system.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroupNames()"><!-- --></A><H3>
getGroupNames</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="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>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getGroupNames()">GroupProvider</A></CODE></B></DD>
<DD>Returns the Collection of all group names in the system.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getGroupNames()">getGroupNames</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the Collection of all groups.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroupNames(int, int)"><!-- --></A><H3>
getGroupNames</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="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>(int&nbsp;startIndex,
                                        int&nbsp;numResults)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getGroupNames(int, int)">GroupProvider</A></CODE></B></DD>
<DD>Returns the Collection of all groups in the system.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getGroupNames(int, int)">getGroupNames</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A></CODE></DL>
</DD>
<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>
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="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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getGroupNames(org.xmpp.packet.JID)">GroupProvider</A></CODE></B></DD>
<DD>Returns the Collection of group names that an entity belongs to.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#getGroupNames(org.xmpp.packet.JID)">getGroupNames</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A></CODE></DL>
</DD>
<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>
public 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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#addMember(java.lang.String, org.xmpp.packet.JID, boolean)">GroupProvider</A></CODE></B></DD>
<DD>Adds an entity to a group (optional operation).
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html#addMember(java.lang.String, org.xmpp.packet.JID, boolean)">addMember</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/group/GroupProvider.html" title="interface in org.jivesoftware.openfire.group">GroupProvider</A></CODE></DL>
</DD>
<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>