root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/ISourceable.java

/**
* Copyright (C) 2009 EDIT
* European Distributed Institute of Taxonomy
* http://www.e-taxonomy.eu
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* See LICENSE.TXT at the top of this package for the full license terms.
*/ 

package eu.etaxonomy.cdm.model.common;

import java.util.Set;

import eu.etaxonomy.cdm.model.reference.Reference;

 
public interface ISourceable<T extends IOriginalSource> {

        /**
         * Returns the set of original sources (citations) for this sourceable object
         * @return
         */
        public Set<T> getSources();

        /**
         * Adds a source to this object
         * @param source
         */
        public void addSource(T source);
        
        
        /**
         * Adds a source that is newly created by its components. If all components are <code>null</null>
         * no source is added.
         * @param id
         * @param idNamespace
         * @param citation
         * @param microCitation
         */
        public T addSource(String id, String idNamespace, Reference citation, String microCitation);
                

        /**
         * Removes a source from this object
         * @param source
         */
        public void removeSource(T source);

}