001    /**
002     * Copyright (c) 2000-2012 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> getAvailableLanguageIds();
035    
036            public java.util.List<java.lang.String> getChildrenFieldNames(
037                    java.lang.String fieldName)
038                    throws com.liferay.portal.kernel.exception.PortalException,
039                            com.liferay.portal.kernel.exception.SystemException;
040    
041            public java.lang.String getCompleteXsd()
042                    throws com.liferay.portal.kernel.exception.PortalException,
043                            com.liferay.portal.kernel.exception.SystemException;
044    
045            public java.lang.String getDefaultLanguageId();
046    
047            public com.liferay.portal.kernel.xml.Document getDocument();
048    
049            public java.lang.String getFieldDataType(java.lang.String fieldName)
050                    throws com.liferay.portal.kernel.exception.PortalException,
051                            com.liferay.portal.kernel.exception.SystemException;
052    
053            public java.lang.String getFieldLabel(java.lang.String fieldName,
054                    java.util.Locale locale)
055                    throws com.liferay.portal.kernel.exception.PortalException,
056                            com.liferay.portal.kernel.exception.SystemException;
057    
058            public java.lang.String getFieldLabel(java.lang.String fieldName,
059                    java.lang.String locale)
060                    throws com.liferay.portal.kernel.exception.PortalException,
061                            com.liferay.portal.kernel.exception.SystemException;
062    
063            public java.util.Set<java.lang.String> getFieldNames()
064                    throws com.liferay.portal.kernel.exception.PortalException,
065                            com.liferay.portal.kernel.exception.SystemException;
066    
067            public java.lang.String getFieldProperty(java.lang.String fieldName,
068                    java.lang.String property)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException;
071    
072            public java.lang.String getFieldProperty(java.lang.String fieldName,
073                    java.lang.String property, java.lang.String locale)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            public boolean getFieldRequired(java.lang.String fieldName)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            public java.util.Map<java.lang.String, java.lang.String> getFields(
082                    java.lang.String fieldName, java.lang.String attributeName,
083                    java.lang.String attributeValue);
084    
085            public java.util.Map<java.lang.String, java.lang.String> getFields(
086                    java.lang.String fieldName, java.lang.String attributeName,
087                    java.lang.String attributeValue, java.lang.String locale);
088    
089            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getFieldsMap()
090                    throws com.liferay.portal.kernel.exception.PortalException,
091                            com.liferay.portal.kernel.exception.SystemException;
092    
093            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getFieldsMap(
094                    java.lang.String locale)
095                    throws com.liferay.portal.kernel.exception.PortalException,
096                            com.liferay.portal.kernel.exception.SystemException;
097    
098            public java.lang.String getFieldType(java.lang.String fieldName)
099                    throws com.liferay.portal.kernel.exception.PortalException,
100                            com.liferay.portal.kernel.exception.SystemException;
101    
102            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedFieldsMap();
103    
104            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedTransientFieldsMap();
105    
106            public java.util.List<java.lang.String> getRootFieldNames()
107                    throws com.liferay.portal.kernel.exception.PortalException,
108                            com.liferay.portal.kernel.exception.SystemException;
109    
110            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates()
111                    throws com.liferay.portal.kernel.exception.SystemException;
112    
113            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getTransientFieldsMap(
114                    java.lang.String locale)
115                    throws com.liferay.portal.kernel.exception.PortalException,
116                            com.liferay.portal.kernel.exception.SystemException;
117    
118            public boolean hasField(java.lang.String fieldName)
119                    throws com.liferay.portal.kernel.exception.PortalException,
120                            com.liferay.portal.kernel.exception.SystemException;
121    
122            public boolean isFieldPrivate(java.lang.String fieldName)
123                    throws com.liferay.portal.kernel.exception.PortalException,
124                            com.liferay.portal.kernel.exception.SystemException;
125    
126            public boolean isFieldRepeatable(java.lang.String fieldName)
127                    throws com.liferay.portal.kernel.exception.PortalException,
128                            com.liferay.portal.kernel.exception.SystemException;
129    
130            public void prepareLocalizedFieldsForImport(
131                    java.util.Locale defaultImportLocale)
132                    throws com.liferay.portal.LocaleException;
133    
134            public void setDocument(com.liferay.portal.kernel.xml.Document document);
135    
136            public void setLocalizedFieldsMap(
137                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedFieldsMap);
138    
139            public void setLocalizedTransientFieldsMap(
140                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedTransientFieldsMap);
141    
142            public void setXsd(java.lang.String xsd);
143    }