001    //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/ogcwebservices/wms/operation/GetMapResult.java $
002    /*----------------    FILE HEADER  ------------------------------------------
003    
004    This file is part of deegree.
005    Copyright (C) 2001-2008 by:
006    EXSE, Department of Geography, University of Bonn
007    http://www.giub.uni-bonn.de/deegree/
008    lat/lon GmbH
009    http://www.lat-lon.de
010    
011    This library is free software; you can redistribute it and/or
012    modify it under the terms of the GNU Lesser General Public
013    License as published by the Free Software Foundation; either
014    version 2.1 of the License, or (at your option) any later version.
015    
016    This library is distributed in the hope that it will be useful,
017    but WITHOUT ANY WARRANTY; without even the implied warranty of
018    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
019    Lesser General Public License for more details.
020    
021    You should have received a copy of the GNU Lesser General Public
022    License along with this library; if not, write to the Free Software
023    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
024    
025    Contact:
026    
027    Andreas Poth
028    lat/lon GmbH
029    Aennchenstr. 19
030    53115 Bonn
031    Germany
032    E-Mail: poth@lat-lon.de
033    
034    Prof. Dr. Klaus Greve
035    Department of Geography
036    University of Bonn
037    Meckenheimer Allee 166
038    53115 Bonn
039    Germany
040    E-Mail: greve@giub.uni-bonn.de
041    
042                     
043     ---------------------------------------------------------------------------*/
044    package org.deegree.ogcwebservices.wms.operation;
045    
046    import org.deegree.ogcwebservices.DefaultOGCWebServiceResponse;
047    import org.deegree.ogcwebservices.OGCWebServiceException;
048    import org.deegree.ogcwebservices.OGCWebServiceRequest;
049    
050    
051    /**
052     * This interface describes the access to the response of a GetMap request.<p></p>
053     * The response to a valid GetMap request shall be a map of the georeferenced
054     * information layer requested, in the desired style, and having the specified
055     * spatial reference system, bounding box, size, format and transparency.<p></p>
056     * An invalid GetMap request shall yield an error output in the requested
057     * Exceptions format (or a network protocol error response in extreme cases).
058     * In an HTTP environment, the MIME type of the returned value's Content-type
059     * entity header shall match the format of the return value.
060     * <p>----------------------------------------------------------------------</p>
061     * @author <a href="mailto:k.lupp@web.de">Katharina Lupp</a>
062     * @version 2002-03-01
063     */
064    public class GetMapResult extends DefaultOGCWebServiceResponse {
065        private Object map = null;
066    
067        /**
068         * constructor initializing the class with the <GetMapResult>
069         */
070        GetMapResult(  OGCWebServiceRequest request, Object map) {
071            super( request );
072            setMap( map );
073        }
074        
075        /**
076         * constructor initializing the class with the <GetMapResult>
077         */
078        GetMapResult(  OGCWebServiceRequest request, OGCWebServiceException exception) {
079            super( request, exception );
080            setMap( map );
081        }
082    
083        /**
084         * @return the map that fullfills the GetMap request. If a exception raised
085         * generating the map and the exception format doesn't equals
086         * application/vnd.ogc.se_inimage or application/vnd.ogc.se_blank <tt>null</tt>
087         * will be returned.
088         */
089        public Object getMap() {
090            return map;
091        }
092    
093        /**
094         * sets the map that fullfills the GetMap request. 
095         * 
096         * @param map 
097         */
098        public void setMap( Object map ) {
099            this.map = map;
100        }
101    }