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> getChildrenFieldNames(
035                    java.lang.String fieldName)
036                    throws com.liferay.portal.kernel.exception.PortalException,
037                            com.liferay.portal.kernel.exception.SystemException;
038    
039            public java.lang.String getCompleteXsd()
040                    throws com.liferay.portal.kernel.exception.PortalException,
041                            com.liferay.portal.kernel.exception.SystemException;
042    
043            public com.liferay.portal.kernel.xml.Document getDocument();
044    
045            public java.lang.String getFieldDataType(java.lang.String fieldName)
046                    throws com.liferay.portal.kernel.exception.PortalException,
047                            com.liferay.portal.kernel.exception.SystemException;
048    
049            public java.lang.String getFieldLabel(java.lang.String fieldName,
050                    java.util.Locale locale)
051                    throws com.liferay.portal.kernel.exception.PortalException,
052                            com.liferay.portal.kernel.exception.SystemException;
053    
054            public java.lang.String getFieldLabel(java.lang.String fieldName,
055                    java.lang.String locale)
056                    throws com.liferay.portal.kernel.exception.PortalException,
057                            com.liferay.portal.kernel.exception.SystemException;
058    
059            public java.util.Set<java.lang.String> getFieldNames()
060                    throws com.liferay.portal.kernel.exception.PortalException,
061                            com.liferay.portal.kernel.exception.SystemException;
062    
063            public java.lang.String getFieldProperty(java.lang.String fieldName,
064                    java.lang.String property)
065                    throws com.liferay.portal.kernel.exception.PortalException,
066                            com.liferay.portal.kernel.exception.SystemException;
067    
068            public java.lang.String getFieldProperty(java.lang.String fieldName,
069                    java.lang.String property, java.lang.String locale)
070                    throws com.liferay.portal.kernel.exception.PortalException,
071                            com.liferay.portal.kernel.exception.SystemException;
072    
073            public boolean getFieldRepeatable(java.lang.String fieldName)
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 getFieldTip(java.lang.String fieldName,
099                    java.util.Locale locale)
100                    throws com.liferay.portal.kernel.exception.PortalException,
101                            com.liferay.portal.kernel.exception.SystemException;
102    
103            public java.lang.String getFieldTip(java.lang.String fieldName,
104                    java.lang.String locale)
105                    throws com.liferay.portal.kernel.exception.PortalException,
106                            com.liferay.portal.kernel.exception.SystemException;
107    
108            public java.lang.String getFieldType(java.lang.String fieldName)
109                    throws com.liferay.portal.kernel.exception.PortalException,
110                            com.liferay.portal.kernel.exception.SystemException;
111    
112            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedFieldsMap();
113    
114            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedTransientFieldsMap();
115    
116            public java.util.List<java.lang.String> getRootFieldNames()
117                    throws com.liferay.portal.kernel.exception.PortalException,
118                            com.liferay.portal.kernel.exception.SystemException;
119    
120            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates()
121                    throws com.liferay.portal.kernel.exception.SystemException;
122    
123            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getTransientFieldsMap(
124                    java.lang.String locale)
125                    throws com.liferay.portal.kernel.exception.PortalException,
126                            com.liferay.portal.kernel.exception.SystemException;
127    
128            /**
129            * Returns the WebDAV URL to access the structure.
130            *
131            * @param themeDisplay the theme display needed to build the URL. It can
132            set HTTPS access, the server name, the server port, the path
133            context, and the scope group.
134            * @param webDAVToken the WebDAV token for the URL
135            * @return the WebDAV URL
136            */
137            public java.lang.String getWebDavURL(
138                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
139                    java.lang.String webDAVToken);
140    
141            public boolean hasField(java.lang.String fieldName)
142                    throws com.liferay.portal.kernel.exception.PortalException,
143                            com.liferay.portal.kernel.exception.SystemException;
144    
145            public boolean isFieldPrivate(java.lang.String fieldName)
146                    throws com.liferay.portal.kernel.exception.PortalException,
147                            com.liferay.portal.kernel.exception.SystemException;
148    
149            public boolean isFieldRepeatable(java.lang.String fieldName)
150                    throws com.liferay.portal.kernel.exception.PortalException,
151                            com.liferay.portal.kernel.exception.SystemException;
152    
153            public void setDocument(com.liferay.portal.kernel.xml.Document document);
154    
155            public void setLocalizedFieldsMap(
156                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedFieldsMap);
157    
158            public void setLocalizedTransientFieldsMap(
159                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedTransientFieldsMap);
160    }