idicteditservice.java.netbeans-base

使用OSGi框架开发的分布式电子辞典

/*
 * @(#)IDictEditService.java
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Library General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
package cn.edu.ynu.sei.dict.core.service;

import cn.edu.ynu.sei.dict.core.exception.DuplicateWordException;
import cn.edu.ynu.sei.dict.core.exception.NotFoundWordException;

/**
 * StoneAge Dictionary edit engine base.
 * @author 88250
 * @author zy
 * @version 1.4.0.0, Mar 12, 2008
 */
public interface IDictEditService {

    /**
     * Add a word into dictionary.
     * <p>
     * Before you add a new word, please invoke 
     * {@link cn.edu.ynu.sei.dict.core.service.IDictQueryService} method 
     * to get a <code>Word</code>.
     * </p>
     * @param vocabulary encapsulated new word need to be created
     */
    void addVocabulary(Word vocabulary) throws DuplicateWordException;

    /**
     * Drop a word(including word, and its definition) from dictionary.
     * @param vocabulary specified, need to be deleted word
     * @throws cn.edu.ynu.sei.dict.core.exception.NotFoundWordException 
     *         if the specified <code>vocabulary</code> not found in dictionary,
     *         will throw this excepiton
     */
    void deleteVocabulary(Word vocabulary) throws NotFoundWordException;

    /**
     * Update the <b>definition</b> of a word.
     * <p>
     * Before you editing a word, please invoke 
     * {@link cn.edu.ynu.sei.dict.core.service.IDictQueryService} method to get a
     * <code>Word</code>. <bt>
     * And then, at your purpose to modify the word definition(or translation) part. <br>
     * At last, encapsulate your word, invoke this method as argument.
     * </p>
     * <br>
     * <b>Notice: </b>if you modify word itself(spelling), this method will add a new
     * word({@link #addVocabulary}) in dictionary without updating the original word.
     * @param vocabulary the encapsulated word need to be updated
     */
    void editVocabulary(Word vocabulary);
}