001    /**
002     * Copyright (c) 2000-2012 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.portal.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.service.ServiceContext;
019    
020    import com.liferay.portlet.expando.model.ExpandoBridge;
021    
022    import java.io.Serializable;
023    
024    import java.util.Locale;
025    import java.util.Map;
026    
027    /**
028     * The base model interface for the LayoutPrototype service. Represents a row in the "LayoutPrototype" database table, with each column mapped to a property of this class.
029     *
030     * <p>
031     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LayoutPrototypeModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portal.model.impl.LayoutPrototypeImpl}.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see LayoutPrototype
036     * @see com.liferay.portal.model.impl.LayoutPrototypeImpl
037     * @see com.liferay.portal.model.impl.LayoutPrototypeModelImpl
038     * @generated
039     */
040    public interface LayoutPrototypeModel extends BaseModel<LayoutPrototype> {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. All methods that expect a layout prototype model instance should use the {@link LayoutPrototype} interface instead.
045             */
046    
047            /**
048             * Returns the primary key of this layout prototype.
049             *
050             * @return the primary key of this layout prototype
051             */
052            public long getPrimaryKey();
053    
054            /**
055             * Sets the primary key of this layout prototype.
056             *
057             * @param primaryKey the primary key of this layout prototype
058             */
059            public void setPrimaryKey(long primaryKey);
060    
061            /**
062             * Returns the uuid of this layout prototype.
063             *
064             * @return the uuid of this layout prototype
065             */
066            @AutoEscape
067            public String getUuid();
068    
069            /**
070             * Sets the uuid of this layout prototype.
071             *
072             * @param uuid the uuid of this layout prototype
073             */
074            public void setUuid(String uuid);
075    
076            /**
077             * Returns the layout prototype ID of this layout prototype.
078             *
079             * @return the layout prototype ID of this layout prototype
080             */
081            public long getLayoutPrototypeId();
082    
083            /**
084             * Sets the layout prototype ID of this layout prototype.
085             *
086             * @param layoutPrototypeId the layout prototype ID of this layout prototype
087             */
088            public void setLayoutPrototypeId(long layoutPrototypeId);
089    
090            /**
091             * Returns the company ID of this layout prototype.
092             *
093             * @return the company ID of this layout prototype
094             */
095            public long getCompanyId();
096    
097            /**
098             * Sets the company ID of this layout prototype.
099             *
100             * @param companyId the company ID of this layout prototype
101             */
102            public void setCompanyId(long companyId);
103    
104            /**
105             * Returns the name of this layout prototype.
106             *
107             * @return the name of this layout prototype
108             */
109            public String getName();
110    
111            /**
112             * Returns the localized name of this layout prototype in the language. Uses the default language if no localization exists for the requested language.
113             *
114             * @param locale the locale of the language
115             * @return the localized name of this layout prototype
116             */
117            @AutoEscape
118            public String getName(Locale locale);
119    
120            /**
121             * Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language.
122             *
123             * @param locale the local of the language
124             * @param useDefault whether to use the default language if no localization exists for the requested language
125             * @return the localized name of this layout prototype. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
126             */
127            @AutoEscape
128            public String getName(Locale locale, boolean useDefault);
129    
130            /**
131             * Returns the localized name of this layout prototype in the language. Uses the default language if no localization exists for the requested language.
132             *
133             * @param languageId the ID of the language
134             * @return the localized name of this layout prototype
135             */
136            @AutoEscape
137            public String getName(String languageId);
138    
139            /**
140             * Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language.
141             *
142             * @param languageId the ID of the language
143             * @param useDefault whether to use the default language if no localization exists for the requested language
144             * @return the localized name of this layout prototype
145             */
146            @AutoEscape
147            public String getName(String languageId, boolean useDefault);
148    
149            @AutoEscape
150            public String getNameCurrentLanguageId();
151    
152            @AutoEscape
153            public String getNameCurrentValue();
154    
155            /**
156             * Returns a map of the locales and localized names of this layout prototype.
157             *
158             * @return the locales and localized names of this layout prototype
159             */
160            public Map<Locale, String> getNameMap();
161    
162            /**
163             * Sets the name of this layout prototype.
164             *
165             * @param name the name of this layout prototype
166             */
167            public void setName(String name);
168    
169            /**
170             * Sets the localized name of this layout prototype in the language.
171             *
172             * @param name the localized name of this layout prototype
173             * @param locale the locale of the language
174             */
175            public void setName(String name, Locale locale);
176    
177            /**
178             * Sets the localized name of this layout prototype in the language, and sets the default locale.
179             *
180             * @param name the localized name of this layout prototype
181             * @param locale the locale of the language
182             * @param defaultLocale the default locale
183             */
184            public void setName(String name, Locale locale, Locale defaultLocale);
185    
186            public void setNameCurrentLanguageId(String languageId);
187    
188            /**
189             * Sets the localized names of this layout prototype from the map of locales and localized names.
190             *
191             * @param nameMap the locales and localized names of this layout prototype
192             */
193            public void setNameMap(Map<Locale, String> nameMap);
194    
195            /**
196             * Sets the localized names of this layout prototype from the map of locales and localized names, and sets the default locale.
197             *
198             * @param nameMap the locales and localized names of this layout prototype
199             * @param defaultLocale the default locale
200             */
201            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
202    
203            /**
204             * Returns the description of this layout prototype.
205             *
206             * @return the description of this layout prototype
207             */
208            @AutoEscape
209            public String getDescription();
210    
211            /**
212             * Sets the description of this layout prototype.
213             *
214             * @param description the description of this layout prototype
215             */
216            public void setDescription(String description);
217    
218            /**
219             * Returns the settings of this layout prototype.
220             *
221             * @return the settings of this layout prototype
222             */
223            @AutoEscape
224            public String getSettings();
225    
226            /**
227             * Sets the settings of this layout prototype.
228             *
229             * @param settings the settings of this layout prototype
230             */
231            public void setSettings(String settings);
232    
233            /**
234             * Returns the active of this layout prototype.
235             *
236             * @return the active of this layout prototype
237             */
238            public boolean getActive();
239    
240            /**
241             * Returns <code>true</code> if this layout prototype is active.
242             *
243             * @return <code>true</code> if this layout prototype is active; <code>false</code> otherwise
244             */
245            public boolean isActive();
246    
247            /**
248             * Sets whether this layout prototype is active.
249             *
250             * @param active the active of this layout prototype
251             */
252            public void setActive(boolean active);
253    
254            public boolean isNew();
255    
256            public void setNew(boolean n);
257    
258            public boolean isCachedModel();
259    
260            public void setCachedModel(boolean cachedModel);
261    
262            public boolean isEscapedModel();
263    
264            public Serializable getPrimaryKeyObj();
265    
266            public void setPrimaryKeyObj(Serializable primaryKeyObj);
267    
268            public ExpandoBridge getExpandoBridge();
269    
270            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
271    
272            public Object clone();
273    
274            public int compareTo(LayoutPrototype layoutPrototype);
275    
276            public int hashCode();
277    
278            public CacheModel<LayoutPrototype> toCacheModel();
279    
280            public LayoutPrototype toEscapedModel();
281    
282            public String toString();
283    
284            public String toXmlString();
285    }