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> 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 getFieldRepeatable(java.lang.String fieldName)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            public boolean getFieldRequired(java.lang.String fieldName)
082                    throws com.liferay.portal.kernel.exception.PortalException,
083                            com.liferay.portal.kernel.exception.SystemException;
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);
088    
089            public java.util.Map<java.lang.String, java.lang.String> getFields(
090                    java.lang.String fieldName, java.lang.String attributeName,
091                    java.lang.String attributeValue, java.lang.String locale);
092    
093            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getFieldsMap()
094                    throws com.liferay.portal.kernel.exception.PortalException,
095                            com.liferay.portal.kernel.exception.SystemException;
096    
097            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getFieldsMap(
098                    java.lang.String locale)
099                    throws com.liferay.portal.kernel.exception.PortalException,
100                            com.liferay.portal.kernel.exception.SystemException;
101    
102            public java.lang.String getFieldTip(java.lang.String fieldName,
103                    java.util.Locale locale)
104                    throws com.liferay.portal.kernel.exception.PortalException,
105                            com.liferay.portal.kernel.exception.SystemException;
106    
107            public java.lang.String getFieldTip(java.lang.String fieldName,
108                    java.lang.String locale)
109                    throws com.liferay.portal.kernel.exception.PortalException,
110                            com.liferay.portal.kernel.exception.SystemException;
111    
112            public java.lang.String getFieldType(java.lang.String fieldName)
113                    throws com.liferay.portal.kernel.exception.PortalException,
114                            com.liferay.portal.kernel.exception.SystemException;
115    
116            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedFieldsMap();
117    
118            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedTransientFieldsMap();
119    
120            public java.util.List<java.lang.String> getRootFieldNames()
121                    throws com.liferay.portal.kernel.exception.PortalException,
122                            com.liferay.portal.kernel.exception.SystemException;
123    
124            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates()
125                    throws com.liferay.portal.kernel.exception.SystemException;
126    
127            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getTransientFieldsMap(
128                    java.lang.String locale)
129                    throws com.liferay.portal.kernel.exception.PortalException,
130                            com.liferay.portal.kernel.exception.SystemException;
131    
132            /**
133            * Returns the WebDAV URL to access the structure.
134            *
135            * @param themeDisplay the theme display needed to build the URL. It can
136            set HTTPS access, the server name, the server port, the path
137            context, and the scope group.
138            * @param webDAVToken the WebDAV token for the URL
139            * @return the WebDAV URL
140            */
141            public java.lang.String getWebDavURL(
142                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
143                    java.lang.String webDAVToken);
144    
145            public boolean hasField(java.lang.String fieldName)
146                    throws com.liferay.portal.kernel.exception.PortalException,
147                            com.liferay.portal.kernel.exception.SystemException;
148    
149            public boolean isFieldPrivate(java.lang.String fieldName)
150                    throws com.liferay.portal.kernel.exception.PortalException,
151                            com.liferay.portal.kernel.exception.SystemException;
152    
153            public boolean isFieldRepeatable(java.lang.String fieldName)
154                    throws com.liferay.portal.kernel.exception.PortalException,
155                            com.liferay.portal.kernel.exception.SystemException;
156    
157            public void prepareLocalizedFieldsForImport(
158                    java.util.Locale defaultImportLocale)
159                    throws com.liferay.portal.LocaleException;
160    
161            public void setDocument(com.liferay.portal.kernel.xml.Document document);
162    
163            public void setLocalizedFieldsMap(
164                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedFieldsMap);
165    
166            public void setLocalizedTransientFieldsMap(
167                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedTransientFieldsMap);
168    
169            public void setXsd(java.lang.String xsd);
170    }