001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.dynamicdatamapping.util;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.xml.Document;
020    import com.liferay.portal.kernel.xml.XPath;
021    import com.liferay.portlet.dynamicdatamapping.model.DDMStructure;
022    import com.liferay.portlet.dynamicdatamapping.storage.Fields;
023    
024    import java.util.List;
025    import java.util.Locale;
026    
027    /**
028     * @author Bruno Basto
029     * @author Brian Wing Shun Chan
030     */
031    public interface DDMXML {
032    
033            public String formatXML(Document document) throws SystemException;
034    
035            public String formatXML(String xml) throws SystemException;
036    
037            public Fields getFields(DDMStructure structure, String xml)
038                    throws PortalException, SystemException;
039    
040            public Fields getFields(
041                            DDMStructure structure, XPath xPath, String xml,
042                            List<String> fieldNames)
043                    throws PortalException, SystemException;
044    
045            public String getXML(Document document, Fields fields)
046                    throws SystemException;
047    
048            public String getXML(Fields fields) throws SystemException;
049    
050            public String updateXMLDefaultLocale(
051                            String xml, Locale contentDefaultLocale,
052                            Locale contentNewDefaultLocale)
053                    throws SystemException;
054    
055            public String validateXML(String xml) throws PortalException;
056    
057    }