001    /**
002     * Copyright (c) 2000-2013 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 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                    boolean includeTransientFields)
098                    throws com.liferay.portal.kernel.exception.PortalException,
099                            com.liferay.portal.kernel.exception.SystemException;
100    
101            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getFieldsMap(
102                    java.lang.String locale)
103                    throws com.liferay.portal.kernel.exception.PortalException,
104                            com.liferay.portal.kernel.exception.SystemException;
105    
106            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getFieldsMap(
107                    java.lang.String locale, boolean includeTransientFields)
108                    throws com.liferay.portal.kernel.exception.PortalException,
109                            com.liferay.portal.kernel.exception.SystemException;
110    
111            public java.lang.String getFieldTip(java.lang.String fieldName,
112                    java.util.Locale locale)
113                    throws com.liferay.portal.kernel.exception.PortalException,
114                            com.liferay.portal.kernel.exception.SystemException;
115    
116            public java.lang.String getFieldTip(java.lang.String fieldName,
117                    java.lang.String locale)
118                    throws com.liferay.portal.kernel.exception.PortalException,
119                            com.liferay.portal.kernel.exception.SystemException;
120    
121            public java.lang.String getFieldType(java.lang.String fieldName)
122                    throws com.liferay.portal.kernel.exception.PortalException,
123                            com.liferay.portal.kernel.exception.SystemException;
124    
125            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedFieldsMap();
126    
127            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedPersistentFieldsMap();
128    
129            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> getLocalizedTransientFieldsMap();
130    
131            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getPersistentFieldsMap(
132                    java.lang.String locale)
133                    throws com.liferay.portal.kernel.exception.PortalException,
134                            com.liferay.portal.kernel.exception.SystemException;
135    
136            public java.util.List<java.lang.String> getRootFieldNames()
137                    throws com.liferay.portal.kernel.exception.PortalException,
138                            com.liferay.portal.kernel.exception.SystemException;
139    
140            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates()
141                    throws com.liferay.portal.kernel.exception.SystemException;
142    
143            public java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> getTransientFieldsMap(
144                    java.lang.String locale)
145                    throws com.liferay.portal.kernel.exception.PortalException,
146                            com.liferay.portal.kernel.exception.SystemException;
147    
148            public java.lang.String getUnambiguousName(
149                    java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> structures,
150                    long groupId, java.util.Locale locale)
151                    throws com.liferay.portal.kernel.exception.PortalException,
152                            com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the WebDAV URL to access the structure.
156            *
157            * @param themeDisplay the theme display needed to build the URL. It can
158            set HTTPS access, the server name, the server port, the path
159            context, and the scope group.
160            * @param webDAVToken the WebDAV token for the URL
161            * @return the WebDAV URL
162            */
163            public java.lang.String getWebDavURL(
164                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
165                    java.lang.String webDAVToken);
166    
167            public boolean hasField(java.lang.String fieldName)
168                    throws com.liferay.portal.kernel.exception.PortalException,
169                            com.liferay.portal.kernel.exception.SystemException;
170    
171            public boolean isFieldPrivate(java.lang.String fieldName)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            public boolean isFieldRepeatable(java.lang.String fieldName)
176                    throws com.liferay.portal.kernel.exception.PortalException,
177                            com.liferay.portal.kernel.exception.SystemException;
178    
179            public boolean isFieldTransient(java.lang.String fieldName)
180                    throws com.liferay.portal.kernel.exception.PortalException,
181                            com.liferay.portal.kernel.exception.SystemException;
182    
183            public void setDocument(com.liferay.portal.kernel.xml.Document document);
184    
185            public void setLocalizedFieldsMap(
186                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedFieldsMap);
187    
188            public void setLocalizedPersistentFieldsMap(
189                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedPersistentFieldsMap);
190    
191            public void setLocalizedTransientFieldsMap(
192                    java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> localizedTransientFieldsMap);
193    }