001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates()
081                    throws com.liferay.portal.kernel.exception.SystemException;
082    
083            public boolean hasField(java.lang.String fieldName);
084    
085            public void prepareLocalizedFieldsForImport(
086                    java.util.Locale defaultImportLocale)
087                    throws com.liferay.portal.LocaleException;
088    
089            public void setDocument(com.liferay.portal.kernel.xml.Document document);
090    
091            public void setLocalizedFieldsMap(
092                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedFieldsMap);
093    
094            public void setXsd(java.lang.String xsd);
095    }