blob: 1e71da1802d4e966a0e5795604058643c9a65434 [file] [log] [blame]
/****************************************************************************
* Copyright (c) 2004 Composent, Inc. and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Composent, Inc. - initial API and implementation
*****************************************************************************/
package org.eclipse.ecf.presence.ui;
import org.eclipse.ecf.core.IContainer;
import org.eclipse.ui.IViewPart;
/**
* Roster view part that supports adding multiple rosters. Implementers of this
* interface support the addition of an arbitrary number of container instances
* that adapter to IPresenceContainerAdapter, and provide access to an IRoster
* instance via a call to
* <code>IPresenceContainerAdapter.getRosterManager()</code>
*
*/
public interface IMultiRosterViewPart extends IViewPart {
/**
* Add container to the roster view. The container provided should adapter
* to the IPresenceContainerAdapter. If it does not, then false will be
* returned. Note that this method should only be called by the user interface
* thread, and not by some other thread.
*
* @param container
* The container provided should adapter to the
* IPresenceContainerAdapter. If it does not (because container is already
* present in this view part), then false will be
* returned.
*
* @return <code>true</code> if the given container can be added to this roster view.
* <code>false</code> if not. If the container has already been added to
* this view part, then will return <code>false</code>.
*/
public boolean addContainer(IContainer container);
}