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.model;
016    
017    import com.liferay.portal.model.PersistedModel;
018    
019    /**
020     * The extended model interface for the DDMStructure service. Represents a row in the "DDMStructure" database table, with each column mapped to a property of this class.
021     *
022     * @author Brian Wing Shun Chan
023     * @see DDMStructureModel
024     * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureImpl
025     * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl
026     * @generated
027     */
028    public interface DDMStructure extends DDMStructureModel, PersistedModel {
029            /*
030             * NOTE FOR DEVELOPERS:
031             *
032             * Never modify this interface directly. Add methods to {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
033             */
034            public java.util.List<java.lang.String> getAvailableLocales();
035    
036            public java.lang.String getDefaultLocale();
037    
038            public com.liferay.portal.kernel.xml.Document getDocument();
039    
040            public java.lang.String getFieldDataType(java.lang.String fieldName)
041                    throws com.liferay.portlet.dynamicdatamapping.StructureFieldException;
042    
043            public java.lang.String getFieldLabel(java.lang.String fieldName,
044                    java.util.Locale locale)
045                    throws com.liferay.portlet.dynamicdatamapping.StructureFieldException;
046    
047            public java.lang.String getFieldLabel(java.lang.String fieldName,
048                    java.lang.String locale)
049                    throws com.liferay.portlet.dynamicdatamapping.StructureFieldException;
050    
051            public java.util.Set<java.lang.String> getFieldNames();
052    
053            public java.lang.String getFieldProperty(java.lang.String fieldName,
054                    java.lang.String property)
055                    throws com.liferay.portlet.dynamicdatamapping.StructureFieldException;
056    
057            public java.lang.String getFieldProperty(java.lang.String fieldName,
058                    java.lang.String property, java.lang.String locale)
059                    throws com.liferay.portlet.dynamicdatamapping.StructureFieldException;
060    
061            public boolean getFieldRequired(java.lang.String fieldName)
062                    throws com.liferay.portlet.dynamicdatamapping.StructureFieldException;
063    
064            public java.util.Map<java.lang.String, java.lang.String> getFields(
065                    java.lang.String fieldName, java.lang.String attributeName,
066                    java.lang.String attributeValue);
067    
068            public java.util.Map<java.lang.String, java.lang.String> getFields(
069                    java.lang.String fieldName, java.lang.String attributeName,
070                    java.lang.String attributeValue, java.lang.String locale);
071    
072            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getFieldsMap();
073    
074            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getFieldsMap(
075                    java.lang.String locale);
076    
077            public java.lang.String getFieldType(java.lang.String fieldName)
078                    throws com.liferay.portlet.dynamicdatamapping.StructureFieldException;
079    
080            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedFieldsMap();
081    
082            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedTransientFieldsMap();
083    
084            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates()
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getTransientFieldsMap(
088                    java.lang.String locale);
089    
090            public boolean hasField(java.lang.String fieldName);
091    
092            public void prepareLocalizedFieldsForImport(
093                    java.util.Locale defaultImportLocale)
094                    throws com.liferay.portal.LocaleException;
095    
096            public void setDocument(com.liferay.portal.kernel.xml.Document document);
097    
098            public void setLocalizedFieldsMap(
099                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedFieldsMap);
100    
101            public void setLocalizedTransientFieldsMap(
102                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedTransientFieldsMap);
103    
104            public void setXsd(java.lang.String xsd);
105    }