rosteritem.html

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

<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="RosterItem()"><!-- --></A><H3>
RosterItem</H3>
<PRE>
public <B>RosterItem</B>()</PRE>
<DL>
<DD>Constructor added for Externalizable. Do not use this constructor.
<P>
</DL>
<HR>

<A NAME="RosterItem(long, org.xmpp.packet.JID, org.jivesoftware.openfire.roster.RosterItem.SubType, org.jivesoftware.openfire.roster.RosterItem.AskType, org.jivesoftware.openfire.roster.RosterItem.RecvType, java.lang.String, java.util.List)"><!-- --></A><H3>
RosterItem</H3>
<PRE>
public <B>RosterItem</B>(long&nbsp;id,
                  <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid,
                  <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A>&nbsp;subStatus,
                  <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.AskType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.AskType</A>&nbsp;askStatus,
                  <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.RecvType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.RecvType</A>&nbsp;recvStatus,
                  <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;nickname,
                  <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</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;&nbsp;groups)</PRE>
<DL>
</DL>
<HR>

<A NAME="RosterItem(org.xmpp.packet.JID, org.jivesoftware.openfire.roster.RosterItem.SubType, org.jivesoftware.openfire.roster.RosterItem.AskType, org.jivesoftware.openfire.roster.RosterItem.RecvType, java.lang.String, java.util.List)"><!-- --></A><H3>
RosterItem</H3>
<PRE>
public <B>RosterItem</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid,
                  <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A>&nbsp;subStatus,
                  <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.AskType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.AskType</A>&nbsp;askStatus,
                  <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.RecvType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.RecvType</A>&nbsp;recvStatus,
                  <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;nickname,
                  <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</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;&nbsp;groups)</PRE>
<DL>
</DL>
<HR>

<A NAME="RosterItem(org.xmpp.packet.Roster.Item)"><!-- --></A><H3>
RosterItem</H3>
<PRE>
public <B>RosterItem</B>(<A HREF="../../../../org/xmpp/packet/Roster.Item.html" title="class in org.xmpp.packet">Roster.Item</A>&nbsp;item)</PRE>
<DL>
<DD>Create a roster item from the data in another one.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>item</CODE> - Item that contains the info of the roster item.</DL>
</DL>

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

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

<A NAME="getSubStatus()"><!-- --></A><H3>
getSubStatus</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A> <B>getSubStatus</B>()</PRE>
<DL>
<DD><p>Obtain the current subscription status of the item.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The subscription status of the item</DL>
</DD>
</DL>
<HR>

<A NAME="setSubStatus(org.jivesoftware.openfire.roster.RosterItem.SubType)"><!-- --></A><H3>
setSubStatus</H3>
<PRE>
public void <B>setSubStatus</B>(<A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A>&nbsp;subStatus)</PRE>
<DL>
<DD><p>Set the current subscription status of the item.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subStatus</CODE> - The subscription status of the item</DL>
</DD>
</DL>
<HR>

<A NAME="getAskStatus()"><!-- --></A><H3>
getAskStatus</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.AskType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.AskType</A> <B>getAskStatus</B>()</PRE>
<DL>
<DD><p>Obtain the current ask status of the item.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The ask status of the item</DL>
</DD>
</DL>
<HR>

<A NAME="setAskStatus(org.jivesoftware.openfire.roster.RosterItem.AskType)"><!-- --></A><H3>
setAskStatus</H3>
<PRE>
public void <B>setAskStatus</B>(<A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.AskType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.AskType</A>&nbsp;askStatus)</PRE>
<DL>
<DD><p>Set the current ask status of the item.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>askStatus</CODE> - The ask status of the item</DL>
</DD>
</DL>
<HR>

<A NAME="getRecvStatus()"><!-- --></A><H3>
getRecvStatus</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.RecvType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.RecvType</A> <B>getRecvStatus</B>()</PRE>
<DL>
<DD><p>Obtain the current recv status of the item.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The recv status of the item</DL>
</DD>
</DL>
<HR>

<A NAME="setRecvStatus(org.jivesoftware.openfire.roster.RosterItem.RecvType)"><!-- --></A><H3>
setRecvStatus</H3>
<PRE>
public void <B>setRecvStatus</B>(<A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.RecvType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.RecvType</A>&nbsp;recvStatus)</PRE>
<DL>
<DD><p>Set the current recv status of the item.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>recvStatus</CODE> - The recv status of the item</DL>
</DD>
</DL>
<HR>

<A NAME="getJid()"><!-- --></A><H3>
getJid</H3>
<PRE>
public <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>getJid</B>()</PRE>
<DL>
<DD><p>Obtain the address of the item.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The address of the item</DL>
</DD>
</DL>
<HR>

<A NAME="getNickname()"><!-- --></A><H3>
getNickname</H3>
<PRE>
public <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> <B>getNickname</B>()</PRE>
<DL>
<DD><p>Obtain the current nickname for the item.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The subscription status of the item</DL>
</DD>
</DL>
<HR>

<A NAME="setNickname(java.lang.String)"><!-- --></A><H3>
setNickname</H3>
<PRE>
public void <B>setNickname</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;nickname)</PRE>
<DL>
<DD><p>Set the current nickname for the item.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nickname</CODE> - The subscription status of the item</DL>
</DD>
</DL>
<HR>

<A NAME="getGroups()"><!-- --></A><H3>
getGroups</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</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>getGroups</B>()</PRE>
<DL>
<DD>Returns the groups for the item. Shared groups won't be included in the answer.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The groups for the item.</DL>
</DD>
</DL>
<HR>

<A NAME="setGroups(java.util.List)"><!-- --></A><H3>
setGroups</H3>
<PRE>
public void <B>setGroups</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</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;&nbsp;groups)
               throws <A HREF="../../../../org/jivesoftware/openfire/SharedGroupException.html" title="class in org.jivesoftware.openfire">SharedGroupException</A></PRE>
<DL>
<DD>Set the current groups for the item.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groups</CODE> - The new lists of groups the item belongs to.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/SharedGroupException.html" title="class in org.jivesoftware.openfire">SharedGroupException</A></CODE> - if trying to remove shared group.</DL>
</DD>
</DL>
<HR>

<A NAME="getSharedGroups()"><!-- --></A><H3>
getSharedGroups</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>getSharedGroups</B>()</PRE>
<DL>
<DD>Returns the shared groups for the item.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The shared groups this item belongs to.</DL>
</DD>
</DL>
<HR>

<A NAME="getInvisibleSharedGroups()"><!-- --></A><H3>
getInvisibleSharedGroups</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>getInvisibleSharedGroups</B>()</PRE>
<DL>