addgroup.html

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

<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="AddGroup()"><!-- --></A><H3>
AddGroup</H3>
<PRE>
public <B>AddGroup</B>()</PRE>
<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="addStageInformation(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)"><!-- --></A><H3>
addStageInformation</H3>
<PRE>
protected void <B>addStageInformation</B>(<A HREF="../../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data,
                                   org.dom4j.Element&nbsp;command)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#addStageInformation(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">AdHocCommand</A></CODE></B></DD>
<DD>Adds to the command element the data form or notes required by the current stage. The
 current stage is specified in the SessionData. This method will never be invoked for
 commands that have no stages.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#addStageInformation(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">addStageInformation</A></CODE> in class <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - the gathered data through the command stages or <tt>null</tt> if the
        command does not have stages or the requester is requesting the execution for the
        first time.<DD><CODE>command</CODE> - the command element to be sent to the command requester.</DL>
</DD>
</DL>
<HR>

<A NAME="execute(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)"><!-- --></A><H3>
execute</H3>
<PRE>
public void <B>execute</B>(<A HREF="../../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data,
                    org.dom4j.Element&nbsp;command)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#execute(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">AdHocCommand</A></CODE></B></DD>
<DD>Executes the command with the specified session data.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#execute(org.jivesoftware.openfire.commands.SessionData, org.dom4j.Element)">execute</A></CODE> in class <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - the gathered data through the command stages or <tt>null</tt> if the
        command does not have stages.<DD><CODE>command</CODE> - the command element to be sent to the command requester with a reported
        data result or note element with the answer of the execution.</DL>
</DD>
</DL>
<HR>

<A NAME="getCode()"><!-- --></A><H3>
getCode</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>getCode</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getCode()">AdHocCommand</A></CODE></B></DD>
<DD>Returns the unique identifier for this command for the containing JID. The code will
 be used as the node in the disco#items or the node when executing the command.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getCode()">getCode</A></CODE> in class <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the unique identifier for this command for the containing JID.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultLabel()"><!-- --></A><H3>
getDefaultLabel</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>getDefaultLabel</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getDefaultLabel()">AdHocCommand</A></CODE></B></DD>
<DD>Returns the default label used for describing this commmand. This information is usually
 used when returning commands as disco#items. Admins can later use <A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#setLabel(java.lang.String)"><CODE>AdHocCommand.setLabel(String)</CODE></A>
 to set a new label and reset to the default value at any time.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getDefaultLabel()">getDefaultLabel</A></CODE> in class <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the default label used for describing this commmand.</DL>
</DD>
</DL>
<HR>

<A NAME="getActions(org.jivesoftware.openfire.commands.SessionData)"><!-- --></A><H3>
getActions</H3>
<PRE>
protected <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="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.Action.html" title="enum in org.jivesoftware.openfire.commands">AdHocCommand.Action</A>&gt; <B>getActions</B>(<A HREF="../../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getActions(org.jivesoftware.openfire.commands.SessionData)">AdHocCommand</A></CODE></B></DD>
<DD>Returns a collection with the allowed actions based on the current stage as defined
 in the SessionData. Possible actions are: <tt>prev</tt>, <tt>next</tt> and <tt>complete</tt>.
 This method will never be invoked for commands that have no stages.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getActions(org.jivesoftware.openfire.commands.SessionData)">getActions</A></CODE> in class <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - the gathered data through the command stages or <tt>null</tt> if the
        command does not have stages or the requester is requesting the execution for the
        first time.
<DT><B>Returns:</B><DD>a collection with the allowed actions based on the current stage as defined
         in the SessionData.</DL>
</DD>
</DL>
<HR>

<A NAME="getExecuteAction(org.jivesoftware.openfire.commands.SessionData)"><!-- --></A><H3>
getExecuteAction</H3>
<PRE>
protected <A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.Action.html" title="enum in org.jivesoftware.openfire.commands">AdHocCommand.Action</A> <B>getExecuteAction</B>(<A HREF="../../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getExecuteAction(org.jivesoftware.openfire.commands.SessionData)">AdHocCommand</A></CODE></B></DD>
<DD>Returns which of the actions available for the current stage is considered the equivalent
 to "execute". When the requester sends his reply, if no action was defined in the command
 then the action will be assumed "execute" thus assuming the action returned by this
 method. This method will never be invoked for commands that have no stages.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getExecuteAction(org.jivesoftware.openfire.commands.SessionData)">getExecuteAction</A></CODE> in class <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - the gathered data through the command stages or <tt>null</tt> if the
        command does not have stages or the requester is requesting the execution for the
        first time.
<DT><B>Returns:</B><DD>which of the actions available for the current stage is considered the equivalent
         to "execute".</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxStages(org.jivesoftware.openfire.commands.SessionData)"><!-- --></A><H3>
getMaxStages</H3>
<PRE>
public int <B>getMaxStages</B>(<A HREF="../../../../../../org/jivesoftware/openfire/commands/SessionData.html" title="class in org.jivesoftware.openfire.commands">SessionData</A>&nbsp;data)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getMaxStages(org.jivesoftware.openfire.commands.SessionData)">AdHocCommand</A></CODE></B></DD>
<DD>Returns the max number of stages for this command. The number of stages may vary according
 to the collected data in previous stages. Therefore, a SessionData object is passed as a
 parameter. When the max number of stages has been reached then the command is ready to
 be executed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html#getMaxStages(org.jivesoftware.openfire.commands.SessionData)">getMaxStages</A></CODE> in class <CODE><A HREF="../../../../../../org/jivesoftware/openfire/commands/AdHocCommand.html" title="class in org.jivesoftware.openfire.commands">AdHocCommand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - the gathered data through the command stages or <tt>null</tt> if the
        command does not have stages or the requester is requesting the execution for the
        first time.
<DT><B>Returns:</B><DD>the max number of stages for this command.</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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../org/jivesoftware/openfire/commands/admin/group/AddGroupUsers.html" title="class in org.jivesoftware.openfire.commands.admin.group"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html?org/jivesoftware/openfire/commands/admin/group/AddGroup.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="AddGroup.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;<A HREF="#nested_classes_inherited_from_class_org.jivesoftware.openfire.commands.AdHocCommand">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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>