001    /**
002     * Copyright (c) 2000-2013 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.LocaleException;
018    import com.liferay.portal.kernel.bean.AutoEscape;
019    import com.liferay.portal.kernel.exception.SystemException;
020    import com.liferay.portal.service.ServiceContext;
021    
022    import com.liferay.portlet.expando.model.ExpandoBridge;
023    
024    import java.io.Serializable;
025    
026    import java.util.Date;
027    import java.util.Locale;
028    import java.util.Map;
029    
030    /**
031     * The base model interface for the LayoutSetPrototype service. Represents a row in the "LayoutSetPrototype" database table, with each column mapped to a property of this class.
032     *
033     * <p>
034     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LayoutSetPrototypeModelImpl} 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.LayoutSetPrototypeImpl}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see LayoutSetPrototype
039     * @see com.liferay.portal.model.impl.LayoutSetPrototypeImpl
040     * @see com.liferay.portal.model.impl.LayoutSetPrototypeModelImpl
041     * @generated
042     */
043    public interface LayoutSetPrototypeModel extends BaseModel<LayoutSetPrototype>,
044            StagedModel {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a layout set prototype model instance should use the {@link LayoutSetPrototype} interface instead.
049             */
050    
051            /**
052             * Returns the primary key of this layout set prototype.
053             *
054             * @return the primary key of this layout set prototype
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this layout set prototype.
060             *
061             * @param primaryKey the primary key of this layout set prototype
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Returns the uuid of this layout set prototype.
067             *
068             * @return the uuid of this layout set prototype
069             */
070            @AutoEscape
071            public String getUuid();
072    
073            /**
074             * Sets the uuid of this layout set prototype.
075             *
076             * @param uuid the uuid of this layout set prototype
077             */
078            public void setUuid(String uuid);
079    
080            /**
081             * Returns the layout set prototype ID of this layout set prototype.
082             *
083             * @return the layout set prototype ID of this layout set prototype
084             */
085            public long getLayoutSetPrototypeId();
086    
087            /**
088             * Sets the layout set prototype ID of this layout set prototype.
089             *
090             * @param layoutSetPrototypeId the layout set prototype ID of this layout set prototype
091             */
092            public void setLayoutSetPrototypeId(long layoutSetPrototypeId);
093    
094            /**
095             * Returns the company ID of this layout set prototype.
096             *
097             * @return the company ID of this layout set prototype
098             */
099            public long getCompanyId();
100    
101            /**
102             * Sets the company ID of this layout set prototype.
103             *
104             * @param companyId the company ID of this layout set prototype
105             */
106            public void setCompanyId(long companyId);
107    
108            /**
109             * Returns the user ID of this layout set prototype.
110             *
111             * @return the user ID of this layout set prototype
112             */
113            public long getUserId();
114    
115            /**
116             * Sets the user ID of this layout set prototype.
117             *
118             * @param userId the user ID of this layout set prototype
119             */
120            public void setUserId(long userId);
121    
122            /**
123             * Returns the user uuid of this layout set prototype.
124             *
125             * @return the user uuid of this layout set prototype
126             * @throws SystemException if a system exception occurred
127             */
128            public String getUserUuid() throws SystemException;
129    
130            /**
131             * Sets the user uuid of this layout set prototype.
132             *
133             * @param userUuid the user uuid of this layout set prototype
134             */
135            public void setUserUuid(String userUuid);
136    
137            /**
138             * Returns the user name of this layout set prototype.
139             *
140             * @return the user name of this layout set prototype
141             */
142            @AutoEscape
143            public String getUserName();
144    
145            /**
146             * Sets the user name of this layout set prototype.
147             *
148             * @param userName the user name of this layout set prototype
149             */
150            public void setUserName(String userName);
151    
152            /**
153             * Returns the create date of this layout set prototype.
154             *
155             * @return the create date of this layout set prototype
156             */
157            public Date getCreateDate();
158    
159            /**
160             * Sets the create date of this layout set prototype.
161             *
162             * @param createDate the create date of this layout set prototype
163             */
164            public void setCreateDate(Date createDate);
165    
166            /**
167             * Returns the modified date of this layout set prototype.
168             *
169             * @return the modified date of this layout set prototype
170             */
171            public Date getModifiedDate();
172    
173            /**
174             * Sets the modified date of this layout set prototype.
175             *
176             * @param modifiedDate the modified date of this layout set prototype
177             */
178            public void setModifiedDate(Date modifiedDate);
179    
180            /**
181             * Returns the name of this layout set prototype.
182             *
183             * @return the name of this layout set prototype
184             */
185            public String getName();
186    
187            /**
188             * Returns the localized name of this layout set prototype in the language. Uses the default language if no localization exists for the requested language.
189             *
190             * @param locale the locale of the language
191             * @return the localized name of this layout set prototype
192             */
193            @AutoEscape
194            public String getName(Locale locale);
195    
196            /**
197             * Returns the localized name of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language.
198             *
199             * @param locale the local of the language
200             * @param useDefault whether to use the default language if no localization exists for the requested language
201             * @return the localized name of this layout set prototype. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
202             */
203            @AutoEscape
204            public String getName(Locale locale, boolean useDefault);
205    
206            /**
207             * Returns the localized name of this layout set prototype in the language. Uses the default language if no localization exists for the requested language.
208             *
209             * @param languageId the ID of the language
210             * @return the localized name of this layout set prototype
211             */
212            @AutoEscape
213            public String getName(String languageId);
214    
215            /**
216             * Returns the localized name of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language.
217             *
218             * @param languageId the ID of the language
219             * @param useDefault whether to use the default language if no localization exists for the requested language
220             * @return the localized name of this layout set prototype
221             */
222            @AutoEscape
223            public String getName(String languageId, boolean useDefault);
224    
225            @AutoEscape
226            public String getNameCurrentLanguageId();
227    
228            @AutoEscape
229            public String getNameCurrentValue();
230    
231            /**
232             * Returns a map of the locales and localized names of this layout set prototype.
233             *
234             * @return the locales and localized names of this layout set prototype
235             */
236            public Map<Locale, String> getNameMap();
237    
238            /**
239             * Sets the name of this layout set prototype.
240             *
241             * @param name the name of this layout set prototype
242             */
243            public void setName(String name);
244    
245            /**
246             * Sets the localized name of this layout set prototype in the language.
247             *
248             * @param name the localized name of this layout set prototype
249             * @param locale the locale of the language
250             */
251            public void setName(String name, Locale locale);
252    
253            /**
254             * Sets the localized name of this layout set prototype in the language, and sets the default locale.
255             *
256             * @param name the localized name of this layout set prototype
257             * @param locale the locale of the language
258             * @param defaultLocale the default locale
259             */
260            public void setName(String name, Locale locale, Locale defaultLocale);
261    
262            public void setNameCurrentLanguageId(String languageId);
263    
264            /**
265             * Sets the localized names of this layout set prototype from the map of locales and localized names.
266             *
267             * @param nameMap the locales and localized names of this layout set prototype
268             */
269            public void setNameMap(Map<Locale, String> nameMap);
270    
271            /**
272             * Sets the localized names of this layout set prototype from the map of locales and localized names, and sets the default locale.
273             *
274             * @param nameMap the locales and localized names of this layout set prototype
275             * @param defaultLocale the default locale
276             */
277            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
278    
279            /**
280             * Returns the description of this layout set prototype.
281             *
282             * @return the description of this layout set prototype
283             */
284            @AutoEscape
285            public String getDescription();
286    
287            /**
288             * Sets the description of this layout set prototype.
289             *
290             * @param description the description of this layout set prototype
291             */
292            public void setDescription(String description);
293    
294            /**
295             * Returns the settings of this layout set prototype.
296             *
297             * @return the settings of this layout set prototype
298             */
299            @AutoEscape
300            public String getSettings();
301    
302            /**
303             * Sets the settings of this layout set prototype.
304             *
305             * @param settings the settings of this layout set prototype
306             */
307            public void setSettings(String settings);
308    
309            /**
310             * Returns the active of this layout set prototype.
311             *
312             * @return the active of this layout set prototype
313             */
314            public boolean getActive();
315    
316            /**
317             * Returns <code>true</code> if this layout set prototype is active.
318             *
319             * @return <code>true</code> if this layout set prototype is active; <code>false</code> otherwise
320             */
321            public boolean isActive();
322    
323            /**
324             * Sets whether this layout set prototype is active.
325             *
326             * @param active the active of this layout set prototype
327             */
328            public void setActive(boolean active);
329    
330            public boolean isNew();
331    
332            public void setNew(boolean n);
333    
334            public boolean isCachedModel();
335    
336            public void setCachedModel(boolean cachedModel);
337    
338            public boolean isEscapedModel();
339    
340            public Serializable getPrimaryKeyObj();
341    
342            public void setPrimaryKeyObj(Serializable primaryKeyObj);
343    
344            public ExpandoBridge getExpandoBridge();
345    
346            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
347    
348            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
349    
350            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
351    
352            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
353                    throws LocaleException;
354    
355            public Object clone();
356    
357            public int compareTo(LayoutSetPrototype layoutSetPrototype);
358    
359            public int hashCode();
360    
361            public CacheModel<LayoutSetPrototype> toCacheModel();
362    
363            public LayoutSetPrototype toEscapedModel();
364    
365            public LayoutSetPrototype toUnescapedModel();
366    
367            public String toString();
368    
369            public String toXmlString();
370    }