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: import java.beans.*;
044:
045: import java.util.*;
046:
047: /**
048: *
049: * @author todd
050: */
051: public interface Conversation {
052: // TODO: methods for moderation
053: ////////////////////////////////////////////////////////////////////////////
054: // Class variables
055: ////////////////////////////////////////////////////////////////////////////
056: public static final String PROP_VALID = "valid";
057: public static final String PROP_CHANNELS = "channels";
058: public static final String PROP_PARTICIPANTS = "participants";
059: public static final String PROP_INVITEES = "invitees";
060: public static final String USER_TYPING_ON = "typingOn";
061: public static final String USER_TYPING_OFF = "typingOff";
062:
063: /**
064: *
065: *
066: */
067: public CollabSession getCollabSession();
068:
069: /**
070: *
071: *
072: */
073: public String getIdentifier();
074:
075: /**
076: *
077: *
078: */
079: public String getDisplayName();
080:
081: /**
082: *
083: *
084: */
085: public boolean isValid();
086:
087: /**
088: *
089: *
090: */
091: public void leave();
092:
093: /**
094: *
095: *
096: */
097: public void invite(CollabPrincipal[] contacts, String inviteMessage);
098:
099: /**
100: *
101: *
102: */
103: public CollabPrincipal[] getParticipants();
104:
105: /**
106: *
107: *
108: */
109: public CollabPrincipal[] getInvitees();
110:
111: /**
112: *
113: *
114: */
115: public Collablet[] getChannels();
116:
117: /**
118: *
119: *
120: */
121: public void addChannel(Collablet channel);
122:
123: /**
124: *
125: *
126: */
127: public CollabMessage createMessage() throws CollabException;
128:
129: /**
130: *
131: *
132: */
133: public void sendMessage(CollabMessage message)
134: throws CollabException;
135:
136: /**
137: *
138: *
139: */
140: public Timer getTimer();
141:
142: /**
143: *
144: *
145: */
146: public boolean isPublic();
147:
148: /**
149: *
150: *
151: */
152: public void subscribe() throws CollabException;
153:
154: /**
155: *
156: *
157: */
158: public void unsubscribe() throws CollabException;
159:
160: /**
161: *
162: *
163: */
164: public int getPrivilege() throws CollabException;
165:
166: /**
167: *
168: *
169: */
170: public int getPrivilege(CollabPrincipal principal)
171: throws CollabException;
172:
173: /**
174: *
175: *
176: */
177: public void addPropertyChangeListener(
178: PropertyChangeListener listener);
179:
180: /**
181: *
182: *
183: */
184: public void removePropertyChangeListener(
185: PropertyChangeListener listener);
186:
187: // public static final String PROP_EVENT="event";
188: }
|