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.dynamic.data.mapping.kernel;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.model.StagedGroupedModel;
021    import com.liferay.portal.kernel.theme.ThemeDisplay;
022    
023    import java.util.Date;
024    import java.util.Locale;
025    import java.util.Map;
026    
027    /**
028     * @author Marcellus Tavares
029     */
030    @ProviderType
031    public interface DDMTemplate extends StagedGroupedModel {
032    
033            public boolean getCacheable();
034    
035            public String getClassName();
036    
037            public long getClassNameId();
038    
039            public long getClassPK();
040    
041            public String getDescription();
042    
043            public String getDescription(Locale locale);
044    
045            public String getDescription(Locale locale, boolean useDefault);
046    
047            public String getDescription(String languageId);
048    
049            public String getDescription(String languageId, boolean useDefault);
050    
051            public String getDescriptionCurrentLanguageId();
052    
053            public String getDescriptionCurrentValue();
054    
055            public Map<Locale, String> getDescriptionMap();
056    
057            @Override
058            public long getGroupId();
059    
060            public String getLanguage();
061    
062            public String getMode();
063    
064            @Override
065            public Date getModifiedDate();
066    
067            public String getName();
068    
069            public String getName(Locale locale);
070    
071            public String getName(Locale locale, boolean useDefault);
072    
073            public String getName(String languageId);
074    
075            public String getName(String languageId, boolean useDefault);
076    
077            public String getNameCurrentLanguageId();
078    
079            public String getNameCurrentValue();
080    
081            public Map<Locale, String> getNameMap();
082    
083            public long getPrimaryKey();
084    
085            public long getResourceClassNameId();
086    
087            public String getScript();
088    
089            public boolean getSmallImage();
090    
091            public long getSmallImageId();
092    
093            public String getSmallImageType() throws PortalException;
094    
095            public String getSmallImageURL();
096    
097            public long getTemplateId();
098    
099            public String getTemplateKey();
100    
101            public String getType();
102    
103            @Override
104            public long getUserId();
105    
106            @Override
107            public String getUserName();
108    
109            public String getVersion();
110    
111            public long getVersionUserId();
112    
113            public String getVersionUserName();
114    
115            public String getWebDavURL(ThemeDisplay themeDisplay, String webDAVToken);
116    
117            public boolean isCacheable();
118    
119            public boolean isSmallImage();
120    
121            public String toXmlString();
122    
123    }