001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.lib.collab.xmpp.jso.iface.x.muc;
043:
044: import org.jabberstudio.jso.NSI;
045: import org.jabberstudio.jso.StreamElement;
046: import java.util.Date;
047:
048: /**
049: * <p>
050: * Interface for representing a history.</p>
051: *
052: *
053: * @author Rahul Shah
054: *
055: */
056: public interface History extends StreamElement {
057:
058: public static final NSI NAME = new NSI("history",
059: MUCQuery.NAMESPACE);
060:
061: //Methods
062: /**
063: * <p>
064: * Retrieves the value of <tt>maxchars</tt> attribute. </p>
065: *
066: * @return The value of maxchars or -1 if maxchars is not present.
067: */
068: public int getMaxChars();
069:
070: /**
071: * <p>
072: * Sets the value of <tt>maxchars</tt> attribute. </p>
073: *
074: * @param The value of maxchars
075: * @throws IllegalArgumentException If the parameter is invalid.
076: */
077: public void setMaxChars(int n) throws IllegalArgumentException;
078:
079: /**
080: * <p>
081: * Retrieves the value of <tt>maxstanzas</tt> attribute. </p>
082: *
083: * @return The value of maxstanzas or -1 if maxstanzas is not present
084: */
085: public int getMaxStanzas();
086:
087: /**
088: * <p>
089: * Sets the value of <tt>maxstanzas</tt> attribute. </p>
090: *
091: * @param The value of maxstanzas
092: * @throws IllegalArgumentException If the parameter is invalid.
093: */
094: public void setMaxStanzas(int n) throws IllegalArgumentException;
095:
096: /**
097: * <p>
098: * Retrieves the value of <tt>seconds</tt> attribute. </p>
099: *
100: * @return The value of seconds or -1 if seconds is not present
101: */
102: public int getSeconds();
103:
104: /**
105: * <p>
106: * Sets the value of <tt>seconds</tt> attribute. </p>
107: *
108: * @param The value of seconds
109: * @throws IllegalArgumentException If the parameter is invalid.
110: */
111: public void setSeconds(int n) throws IllegalArgumentException;
112:
113: /**
114: * <p>
115: * Retrieves the value of <tt>since</tt> attribute. </p>
116: *
117: * @return The value of dateTime or null if since is not present
118: */
119: public Date getSince();
120:
121: /**
122: * <p>
123: * Sets the value of <tt>since</tt> attribute. </p>
124: *
125: * @param The value of dateTime
126: * @throws IllegalArgumentException If the parameter is invalid.
127: */
128: public void setSince(Date dateTime) throws IllegalArgumentException;
129:
130: }
|