001    /**
002     * Copyright (c) 2000-present 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 com.liferay.portlet.dynamicdatamapping.model.DDMForm createFullHierarchyDDMForm()
038                    throws com.liferay.portal.kernel.exception.PortalException;
039    
040            public java.util.List<java.lang.String> getChildrenFieldNames(
041                    java.lang.String fieldName)
042                    throws com.liferay.portal.kernel.exception.PortalException;
043    
044            public com.liferay.portlet.dynamicdatamapping.model.DDMForm getDDMForm();
045    
046            public com.liferay.portlet.dynamicdatamapping.model.DDMFormField getDDMFormField(
047                    java.lang.String fieldName)
048                    throws com.liferay.portal.kernel.exception.PortalException;
049    
050            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMFormField> getDDMFormFields(
051                    boolean includeTransientFields);
052    
053            public com.liferay.portlet.dynamicdatamapping.model.DDMFormLayout getDDMFormLayout()
054                    throws com.liferay.portal.kernel.exception.PortalException;
055    
056            public java.lang.String getFieldDataType(java.lang.String fieldName)
057                    throws com.liferay.portal.kernel.exception.PortalException;
058    
059            public java.lang.String getFieldLabel(java.lang.String fieldName,
060                    java.util.Locale locale)
061                    throws com.liferay.portal.kernel.exception.PortalException;
062    
063            public java.lang.String getFieldLabel(java.lang.String fieldName,
064                    java.lang.String locale)
065                    throws com.liferay.portal.kernel.exception.PortalException;
066    
067            public java.util.Set<java.lang.String> getFieldNames();
068    
069            public java.lang.String getFieldProperty(java.lang.String fieldName,
070                    java.lang.String property)
071                    throws com.liferay.portal.kernel.exception.PortalException;
072    
073            public boolean getFieldRepeatable(java.lang.String fieldName)
074                    throws com.liferay.portal.kernel.exception.PortalException;
075    
076            public boolean getFieldRequired(java.lang.String fieldName)
077                    throws com.liferay.portal.kernel.exception.PortalException;
078    
079            public java.lang.String getFieldTip(java.lang.String fieldName,
080                    java.util.Locale locale)
081                    throws com.liferay.portal.kernel.exception.PortalException;
082    
083            public java.lang.String getFieldTip(java.lang.String fieldName,
084                    java.lang.String locale)
085                    throws com.liferay.portal.kernel.exception.PortalException;
086    
087            public java.lang.String getFieldType(java.lang.String fieldName)
088                    throws com.liferay.portal.kernel.exception.PortalException;
089    
090            public com.liferay.portlet.dynamicdatamapping.model.DDMForm getFullHierarchyDDMForm();
091    
092            public java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.model.DDMFormField> getFullHierarchyDDMFormFieldsMap(
093                    boolean includeNestedDDMFormFields);
094    
095            public java.util.List<java.lang.String> getRootFieldNames();
096    
097            public com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion getStructureVersion()
098                    throws com.liferay.portal.kernel.exception.PortalException;
099    
100            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates();
101    
102            public java.lang.String getUnambiguousName(
103                    java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> structures,
104                    long groupId, java.util.Locale locale)
105                    throws com.liferay.portal.kernel.exception.PortalException;
106    
107            /**
108            * Returns the WebDAV URL to access the structure.
109            *
110            * @param themeDisplay the theme display needed to build the URL. It can
111            set HTTPS access, the server name, the server port, the path
112            context, and the scope group.
113            * @param webDAVToken the WebDAV token for the URL
114            * @return the WebDAV URL
115            */
116            public java.lang.String getWebDavURL(
117                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
118                    java.lang.String webDAVToken);
119    
120            public boolean hasField(java.lang.String fieldName);
121    
122            public boolean isFieldRepeatable(java.lang.String fieldName)
123                    throws com.liferay.portal.kernel.exception.PortalException;
124    
125            public boolean isFieldTransient(java.lang.String fieldName)
126                    throws com.liferay.portal.kernel.exception.PortalException;
127    
128            public void setDDMForm(
129                    com.liferay.portlet.dynamicdatamapping.model.DDMForm ddmForm);
130    
131            public void setFullHierarchyDDMForm(
132                    com.liferay.portlet.dynamicdatamapping.model.DDMForm fullHierarchyDDMForm);
133    
134            public void updateDDMForm(
135                    com.liferay.portlet.dynamicdatamapping.model.DDMForm ddmForm);
136    }