001    /*
002     * 
003     * $Revision: 13085 $ $Date: 2008-02-06 18:27:24 +0100 (Mi, 06 Feb 2008) $
004     *
005     * This file is part of ***  M y C o R e  ***
006     * See http://www.mycore.de/ for details.
007     *
008     * This program is free software; you can use it, redistribute it
009     * and / or modify it under the terms of the GNU General Public License
010     * (GPL) as published by the Free Software Foundation; either version 2
011     * of the License or (at your option) any later version.
012     *
013     * This program is distributed in the hope that it will be useful, but
014     * WITHOUT ANY WARRANTY; without even the implied warranty of
015     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016     * GNU General Public License for more details.
017     *
018     * You should have received a copy of the GNU General Public License
019     * along with this program, in a file called gpl.txt or license.txt.
020     * If not, write to the Free Software Foundation Inc.,
021     * 59 Temple Place - Suite 330, Boston, MA  02111-1307 USA
022     */
023    
024    package org.mycore.services.webservices;
025    
026    public interface MCRWS {
027    
028        /**
029         * Retrieves MyCoRe object
030         * 
031         * @param ID
032         *            The ID of the document to retrieve
033         * 
034         * @return data of mycore object
035         * 
036         */
037        public abstract org.w3c.dom.Document MCRDoRetrieveObject(String ID) throws Exception;
038    
039        /**
040         * Retrieves MyCoRe Classification
041         * 
042         * @param level
043         *            number of levels to retrievwe
044         * @param type
045         *            parents|children
046         * @param classID
047         *            The ID of the classification
048         * @param categID
049         *            categroryID where retrieval with level starts
050         * @param format
051         *            of retrieved classification, valid values are:
052         *            editor['['formatAlias']']|metadata
053         * 
054         * @return data of mycore classification
055         * 
056         */
057        public abstract org.w3c.dom.Document MCRDoRetrieveClassification(String level, String type, String classID, String categID, String format) throws Exception;
058    
059        /**
060         * Search for MyCoRe objects
061         * 
062         * @param query
063         *            as mycore xml query
064         * 
065         * @return resultset of search
066         * 
067         */
068        public abstract org.w3c.dom.Document MCRDoQuery(org.w3c.dom.Document query) throws Exception;
069    
070        /**
071         * Retrieves MyCoRe Links
072         * 
073         * @param from
074         *            the source ID of the link
075         * @param to
076         *            the target ID of the link
077         * @param type
078         *            the link type (if it is null, refernce is default)
079         * 
080         * @return mcr:result JDOM object
081         * 
082         */
083        public abstract org.w3c.dom.Document MCRDoRetrieveLinks(String from, String to, String type) throws Exception;
084    
085    }