001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021
022package org.biojavax.bio.alignment;
023
024import java.io.Serializable;
025import java.util.Set;
026
027import org.biojava.bio.BioException;
028
029/**
030 * RemotePairwiseAlignmentOutputProperties: the simplest representation of an object capable of holding 
031 * output formatting informations to be fed to a RemotePairwiseAlignmentService-implemented object.
032 * 
033 * @author Sylvain Foisy, Diploide BioIT
034 * @since 1.8
035 *
036 *
037 */
038public interface RemotePairwiseAlignmentOutputProperties extends Serializable{
039        /**
040         * 
041         */
042        public static final long serialVersionUID = 1L;
043
044    /**
045     * Method that returns the value associated with the key given in parameter.
046     * 
047     * @param key :a String with the required key for this map.
048     * @return a String with the value associated with this key
049     * @throws BioException if key is not in the map of output options.
050     */
051        public String getOutputOption(String key) throws BioException;
052
053        
054        /**
055         * Method to set the value for a specific output parameter using a key to store in a map.
056         * 
057         * @param key :the key use to designate the value to be stored
058         * @param val :the actual value matched to key
059         */
060        public void setOutputOption(String key,String val);
061
062        /**
063         * Method to get all keys to the information stored in this object.
064         * 
065         * @return a <code>Set</code> with all keys held in this instance of the object 
066         */
067        public Set<String> getOutputOptions();
068}