IServerStoreFacade.java

/*******************************************************************************
 *  Copyright (c) 2010 Weltevree Beheer BV, Remain Software & Industrial-TSI
 *                                                                      
 * 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:                                                        
 *    Wim Jongman - initial API and implementation
 *******************************************************************************/
package org.eclipse.ecf.protocol.nntp.model;

/**
 * This class controls fetching of information from the server or from the
 * store.
 * 
 * @author jongw
 * 
 */
public interface IServerStoreFacade extends IInputOutputSystem,
		IBasicNNTPInterface, IAdministration {

	/**
	 * If an exception occurred in the store or the sever connection it is
	 * stored and you can retrieve it with this method.
	 * 
	 * @return
	 */
	public Exception getLastException();

	/**
	 * Catches up since the last visit to the server and stores the information
	 * in the store.
	 * 
	 * @param newsgroup
	 * @throws NNTPIOException
	 * @throws UnexpectedResponseException
	 */
	public void catchUp(INewsgroup newsgroup) throws NNTPIOException;

	/**
	 * Returns the list of newsgroup this user is subscribed to in this server.
	 * 
	 * @param server
	 * @return
	 * @throws StoreException 
	 */
	public INewsgroup[] getSubscribedNewsgroups(IServer server) throws StoreException;

	/**
	 * Returns the newsgroup this user is subscribed to in this server.
	 * 
	 * @param server
	 * @return {@link INewsgroup} or null
	 */
	public INewsgroup getSubscribedNewsgroup(IServer server, String newsgroup);

	public void init();

	/**
	 * Gets the first store can be null if no store service is active.
	 * 
	 * @return the first store or null if no store is available.
	 */
	public IStore getFirstStore();

	/**
	 * Gets all stores.
	 * 
	 * @return
	 */
	public IStore[] getStores();

	public void updateArticle(IArticle article) throws StoreException;

	/**
	 * Get the current user articles
	 * @param newsgroup Newsgroup
	 * @return the current user articles
	 */
	public IArticle[] getThisUserArticles(INewsgroup newsgroup);
	
	/**
	 * Get marked articles
	 * @param newsgroup Newsgroup
	 * @return marked articles of a particular newsgroup
	 */
	public IArticle[] getMarkedArticles(INewsgroup newsgroup);
	
	/**
	 * 
	 * Get all marked articles
	 * 
	 * @return marked articles for all newsgroups
	 */
	public IArticle[] getAllMarkedArticles(IServer server);
	
	/**
	 * Get article from messageId
	 * 
	 * @param newsgroup
	 *            Newsgroup
	 * @param msgId
	 *            message Id of article
	 * @return article which has the particular message id
	 * 
	 */
	public IArticle getArticleByMsgId(INewsgroup newsgroup, String msgId);
	
	/**
	 * Get the first article of a thread which corresponds to a follow-up
	 * article
	 * 
	 * @param article
	 *            a follow-up article of a thread
	 * 
	 * @return the first article of a thread which corresponds to the follow-up
	 *         article
	 */
	public IArticle getFirstArticleOfTread(IArticle article);
	
	/**
	 * get the first articles of the threads which this user has started or
	 * replied to
	 * 
	 * @param newsgroup
	 *            Newsgroup
	 * @return First articles of the threads which this user has started or
	 *         replied to
	 */
	public IArticle[] getFirstArticleOfThisUserThreads(INewsgroup newsgroup);

	/**
	 * Get the articleNumber of the last reply of the thread of the article
	 * @param article 
	 * @return articleNumber of the last reply of the thread
	 *  
	 */
	public int getLastReplyArticleNumber(IArticle newArticle);
	
	/**
	 * Order Articles from the Newest First.
	 * @param articles articles to be ordered
	 * @return ordered articles
	 */
	public IArticle[] orderArticlesFromNewestFirst(IArticle[] articles);
	
	/**
	 * Get the high Watermark of the newsgroup (in store) 
	 * @param newsgroup
	 * @return the high Watermark of the newsgroup
	 */
	public int getStoreHighWatermark (INewsgroup newsgroup);
	
	/**
	 * Get the watermarks of the newsgroup (from server) 
	 * @param newsgroup
	 * @return the high watermarks of the newsgroup
	 */
	public int[] getServerWatermarks (INewsgroup newsgroup);
	
	/**
	 * Moves the updated attributes from the newsgroup into the
	 * store.
	 * 
	 * @throws NNTPIOException
	 * @throws UnexpectedResponseException
	 * @throws StoreException
	 */
	public void updateAttributesInStore(INewsgroup newsgroup) throws NNTPIOException, UnexpectedResponseException, StoreException;
	
	/**
	 * Update store with the server
	 * @param newsgroup Newsgroup
	 * @param isNewArticlePosted whether a new article is posted just before sync. 
	 */
	public void syncStoreWithServer(INewsgroup newsgroup, boolean isNewArticlePosted) throws NNTPIOException, UnexpectedResponseException, StoreException;
	
}