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 java.lang.String getFieldDataType(java.lang.String fieldName)
054                    throws com.liferay.portal.kernel.exception.PortalException;
055    
056            public java.lang.String getFieldLabel(java.lang.String fieldName,
057                    java.util.Locale locale)
058                    throws com.liferay.portal.kernel.exception.PortalException;
059    
060            public java.lang.String getFieldLabel(java.lang.String fieldName,
061                    java.lang.String locale)
062                    throws com.liferay.portal.kernel.exception.PortalException;
063    
064            public java.util.Set<java.lang.String> getFieldNames();
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    
070            public boolean getFieldRepeatable(java.lang.String fieldName)
071                    throws com.liferay.portal.kernel.exception.PortalException;
072    
073            public boolean getFieldRequired(java.lang.String fieldName)
074                    throws com.liferay.portal.kernel.exception.PortalException;
075    
076            public java.lang.String getFieldTip(java.lang.String fieldName,
077                    java.util.Locale locale)
078                    throws com.liferay.portal.kernel.exception.PortalException;
079    
080            public java.lang.String getFieldTip(java.lang.String fieldName,
081                    java.lang.String locale)
082                    throws com.liferay.portal.kernel.exception.PortalException;
083    
084            public java.lang.String getFieldType(java.lang.String fieldName)
085                    throws com.liferay.portal.kernel.exception.PortalException;
086    
087            public com.liferay.portlet.dynamicdatamapping.model.DDMForm getFullHierarchyDDMForm();
088    
089            public java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.model.DDMFormField> getFullHierarchyDDMFormFieldsMap(
090                    boolean includeNestedDDMFormFields);
091    
092            public java.util.List<java.lang.String> getRootFieldNames();
093    
094            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> getTemplates();
095    
096            public java.lang.String getUnambiguousName(
097                    java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> structures,
098                    long groupId, java.util.Locale locale)
099                    throws com.liferay.portal.kernel.exception.PortalException;
100    
101            /**
102            * Returns the WebDAV URL to access the structure.
103            *
104            * @param themeDisplay the theme display needed to build the URL. It can
105            set HTTPS access, the server name, the server port, the path
106            context, and the scope group.
107            * @param webDAVToken the WebDAV token for the URL
108            * @return the WebDAV URL
109            */
110            public java.lang.String getWebDavURL(
111                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
112                    java.lang.String webDAVToken);
113    
114            public boolean hasField(java.lang.String fieldName);
115    
116            public boolean isFieldPrivate(java.lang.String fieldName);
117    
118            public boolean isFieldRepeatable(java.lang.String fieldName)
119                    throws com.liferay.portal.kernel.exception.PortalException;
120    
121            public boolean isFieldTransient(java.lang.String fieldName)
122                    throws com.liferay.portal.kernel.exception.PortalException;
123    
124            public void setDDMForm(
125                    com.liferay.portlet.dynamicdatamapping.model.DDMForm ddmForm);
126    
127            public void setFullHierarchyDDMForm(
128                    com.liferay.portlet.dynamicdatamapping.model.DDMForm fullHierarchyDDMForm);
129    
130            public void updateDDMForm(
131                    com.liferay.portlet.dynamicdatamapping.model.DDMForm ddmForm);
132    }