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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.model.PersistedModel;
020    
021    /**
022     * 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.
023     *
024     * @author Brian Wing Shun Chan
025     * @see DDMStructureModel
026     * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureImpl
027     * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl
028     * @generated
029     */
030    @ProviderType
031    public interface DDMStructure extends DDMStructureModel, PersistedModel {
032            /*
033             * NOTE FOR DEVELOPERS:
034             *
035             * 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.
036             */
037            public java.util.List<java.lang.String> getChildrenFieldNames(
038                    java.lang.String fieldName)
039                    throws com.liferay.portal.kernel.exception.PortalException,
040                            com.liferay.portal.kernel.exception.SystemException;
041    
042            public java.lang.String getCompleteXsd()
043                    throws com.liferay.portal.kernel.exception.PortalException,
044                            com.liferay.portal.kernel.exception.SystemException;
045    
046            public com.liferay.portal.kernel.xml.Document getDocument();
047    
048            public java.lang.String getFieldDataType(java.lang.String fieldName)
049                    throws com.liferay.portal.kernel.exception.PortalException,
050                            com.liferay.portal.kernel.exception.SystemException;
051    
052            public java.lang.String getFieldLabel(java.lang.String fieldName,
053                    java.util.Locale locale)
054                    throws com.liferay.portal.kernel.exception.PortalException,
055                            com.liferay.portal.kernel.exception.SystemException;
056    
057            public java.lang.String getFieldLabel(java.lang.String fieldName,
058                    java.lang.String locale)
059                    throws com.liferay.portal.kernel.exception.PortalException,
060                            com.liferay.portal.kernel.exception.SystemException;
061    
062            public java.util.Set<java.lang.String> getFieldNames()
063                    throws com.liferay.portal.kernel.exception.PortalException,
064                            com.liferay.portal.kernel.exception.SystemException;
065    
066            public java.lang.String getFieldProperty(java.lang.String fieldName,
067                    java.lang.String property)
068                    throws com.liferay.portal.kernel.exception.PortalException,
069                            com.liferay.portal.kernel.exception.SystemException;
070    
071            public java.lang.String getFieldProperty(java.lang.String fieldName,
072                    java.lang.String property, java.lang.String locale)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException;
075    
076            public boolean getFieldRepeatable(java.lang.String fieldName)
077                    throws com.liferay.portal.kernel.exception.PortalException,
078                            com.liferay.portal.kernel.exception.SystemException;
079    
080            public boolean getFieldRequired(java.lang.String fieldName)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            public java.util.Map<java.lang.String, java.lang.String> getFields(
085                    java.lang.String fieldName, java.lang.String attributeName,
086                    java.lang.String attributeValue);
087    
088            public java.util.Map<java.lang.String, java.lang.String> getFields(
089                    java.lang.String fieldName, java.lang.String attributeName,
090                    java.lang.String attributeValue, java.lang.String locale);
091    
092            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getFieldsMap()
093                    throws com.liferay.portal.kernel.exception.PortalException,
094                            com.liferay.portal.kernel.exception.SystemException;
095    
096            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getFieldsMap(
097                    java.lang.String locale)
098                    throws com.liferay.portal.kernel.exception.PortalException,
099                            com.liferay.portal.kernel.exception.SystemException;
100    
101            public java.lang.String getFieldTip(java.lang.String fieldName,
102                    java.util.Locale locale)
103                    throws com.liferay.portal.kernel.exception.PortalException,
104                            com.liferay.portal.kernel.exception.SystemException;
105    
106            public java.lang.String getFieldTip(java.lang.String fieldName,
107                    java.lang.String locale)
108                    throws com.liferay.portal.kernel.exception.PortalException,
109                            com.liferay.portal.kernel.exception.SystemException;
110    
111            public java.lang.String getFieldType(java.lang.String fieldName)
112                    throws com.liferay.portal.kernel.exception.PortalException,
113                            com.liferay.portal.kernel.exception.SystemException;
114    
115            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedFieldsMap();
116    
117            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedTransientFieldsMap();
118    
119            public java.util.List<java.lang.String> getRootFieldNames()
120                    throws com.liferay.portal.kernel.exception.PortalException,
121                            com.liferay.portal.kernel.exception.SystemException;
122    
123            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates()
124                    throws com.liferay.portal.kernel.exception.SystemException;
125    
126            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getTransientFieldsMap(
127                    java.lang.String locale)
128                    throws com.liferay.portal.kernel.exception.PortalException,
129                            com.liferay.portal.kernel.exception.SystemException;
130    
131            /**
132            * Returns the WebDAV URL to access the structure.
133            *
134            * @param themeDisplay the theme display needed to build the URL. It can
135            set HTTPS access, the server name, the server port, the path
136            context, and the scope group.
137            * @param webDAVToken the WebDAV token for the URL
138            * @return the WebDAV URL
139            */
140            public java.lang.String getWebDavURL(
141                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
142                    java.lang.String webDAVToken);
143    
144            public boolean hasField(java.lang.String fieldName)
145                    throws com.liferay.portal.kernel.exception.PortalException,
146                            com.liferay.portal.kernel.exception.SystemException;
147    
148            public boolean isFieldPrivate(java.lang.String fieldName)
149                    throws com.liferay.portal.kernel.exception.PortalException,
150                            com.liferay.portal.kernel.exception.SystemException;
151    
152            public boolean isFieldRepeatable(java.lang.String fieldName)
153                    throws com.liferay.portal.kernel.exception.PortalException,
154                            com.liferay.portal.kernel.exception.SystemException;
155    
156            public void setDocument(com.liferay.portal.kernel.xml.Document document);
157    
158            public void setLocalizedFieldsMap(
159                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedFieldsMap);
160    
161            public void setLocalizedTransientFieldsMap(
162                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedTransientFieldsMap);
163    }