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: package com.sun.collablet;
042:
043: /**
044: *
045: * @author Todd Fast, todd.fast@sun.com
046: */
047: public interface CollabMessage extends CollabMessagePart {
048: public static final int TYPING_ON = 0;
049: public static final int TYPING_OFF = 1;
050:
051: /**
052: *
053: *
054: */
055: public String getID();
056:
057: /**
058: *
059: *
060: */
061: public CollabPrincipal getOriginator();
062:
063: // /**
064: // *
065: // *
066: // */
067: // public void setOriginator(CollabPrincipal originator)
068: // throws CollabException;
069: // TAF: Apparently not needed for multiuser conference--do we need this at all?
070: // The reason why we might not want it is that it requires equivalence between
071: // principals and various string forms of a recipient.
072: // /**
073: // *
074: // *
075: // */
076: // public CollabPrincipal[] getRecipients()
077: // throws CollabException;
078: //
079: //
080: // /**
081: // *
082: // *
083: // */
084: // public void addRecipient(CollabPrincipal destination)
085: // throws CollabException;
086: //
087: //
088: // /**
089: // *
090: // *
091: // */
092: // public void removeRecipient(CollabPrincipal destination)
093: // throws CollabException;
094:
095: /**
096: *
097: *
098: */
099: public String getHeader(String header);
100:
101: /**
102: *
103: *
104: */
105: public void setHeader(String header, String value)
106: throws CollabException;
107:
108: /**
109: *
110: *
111: */
112: public CollabMessagePart[] getParts();
113:
114: /**
115: *
116: *
117: */
118: public CollabMessagePart newPart() throws CollabException;
119:
120: /**
121: *
122: *
123: */
124: public void addPart(CollabMessagePart part) throws CollabException;
125:
126: /**
127: *
128: *
129: */
130: public void removePart(CollabMessagePart part)
131: throws CollabException;
132:
133: /**
134: *
135: *
136: */
137: public void sendStatus(int status) throws CollabException;
138: }
|