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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.AutoEscape;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.service.ServiceContext;
022    
023    import com.liferay.portlet.expando.model.ExpandoBridge;
024    
025    import java.io.Serializable;
026    
027    import java.util.Date;
028    
029    /**
030     * The base model interface for the LayoutSetBranch service. Represents a row in the "LayoutSetBranch" database table, with each column mapped to a property of this class.
031     *
032     * <p>
033     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LayoutSetBranchModelImpl} 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.LayoutSetBranchImpl}.
034     * </p>
035     *
036     * @author Brian Wing Shun Chan
037     * @see LayoutSetBranch
038     * @see com.liferay.portal.model.impl.LayoutSetBranchImpl
039     * @see com.liferay.portal.model.impl.LayoutSetBranchModelImpl
040     * @generated
041     */
042    @ProviderType
043    public interface LayoutSetBranchModel extends BaseModel<LayoutSetBranch>,
044            GroupedModel {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a layout set branch model instance should use the {@link LayoutSetBranch} interface instead.
049             */
050    
051            /**
052             * Returns the primary key of this layout set branch.
053             *
054             * @return the primary key of this layout set branch
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this layout set branch.
060             *
061             * @param primaryKey the primary key of this layout set branch
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Returns the layout set branch ID of this layout set branch.
067             *
068             * @return the layout set branch ID of this layout set branch
069             */
070            public long getLayoutSetBranchId();
071    
072            /**
073             * Sets the layout set branch ID of this layout set branch.
074             *
075             * @param layoutSetBranchId the layout set branch ID of this layout set branch
076             */
077            public void setLayoutSetBranchId(long layoutSetBranchId);
078    
079            /**
080             * Returns the group ID of this layout set branch.
081             *
082             * @return the group ID of this layout set branch
083             */
084            @Override
085            public long getGroupId();
086    
087            /**
088             * Sets the group ID of this layout set branch.
089             *
090             * @param groupId the group ID of this layout set branch
091             */
092            @Override
093            public void setGroupId(long groupId);
094    
095            /**
096             * Returns the company ID of this layout set branch.
097             *
098             * @return the company ID of this layout set branch
099             */
100            @Override
101            public long getCompanyId();
102    
103            /**
104             * Sets the company ID of this layout set branch.
105             *
106             * @param companyId the company ID of this layout set branch
107             */
108            @Override
109            public void setCompanyId(long companyId);
110    
111            /**
112             * Returns the user ID of this layout set branch.
113             *
114             * @return the user ID of this layout set branch
115             */
116            @Override
117            public long getUserId();
118    
119            /**
120             * Sets the user ID of this layout set branch.
121             *
122             * @param userId the user ID of this layout set branch
123             */
124            @Override
125            public void setUserId(long userId);
126    
127            /**
128             * Returns the user uuid of this layout set branch.
129             *
130             * @return the user uuid of this layout set branch
131             * @throws SystemException if a system exception occurred
132             */
133            @Override
134            public String getUserUuid() throws SystemException;
135    
136            /**
137             * Sets the user uuid of this layout set branch.
138             *
139             * @param userUuid the user uuid of this layout set branch
140             */
141            @Override
142            public void setUserUuid(String userUuid);
143    
144            /**
145             * Returns the user name of this layout set branch.
146             *
147             * @return the user name of this layout set branch
148             */
149            @AutoEscape
150            @Override
151            public String getUserName();
152    
153            /**
154             * Sets the user name of this layout set branch.
155             *
156             * @param userName the user name of this layout set branch
157             */
158            @Override
159            public void setUserName(String userName);
160    
161            /**
162             * Returns the create date of this layout set branch.
163             *
164             * @return the create date of this layout set branch
165             */
166            @Override
167            public Date getCreateDate();
168    
169            /**
170             * Sets the create date of this layout set branch.
171             *
172             * @param createDate the create date of this layout set branch
173             */
174            @Override
175            public void setCreateDate(Date createDate);
176    
177            /**
178             * Returns the modified date of this layout set branch.
179             *
180             * @return the modified date of this layout set branch
181             */
182            @Override
183            public Date getModifiedDate();
184    
185            /**
186             * Sets the modified date of this layout set branch.
187             *
188             * @param modifiedDate the modified date of this layout set branch
189             */
190            @Override
191            public void setModifiedDate(Date modifiedDate);
192    
193            /**
194             * Returns the private layout of this layout set branch.
195             *
196             * @return the private layout of this layout set branch
197             */
198            public boolean getPrivateLayout();
199    
200            /**
201             * Returns <code>true</code> if this layout set branch is private layout.
202             *
203             * @return <code>true</code> if this layout set branch is private layout; <code>false</code> otherwise
204             */
205            public boolean isPrivateLayout();
206    
207            /**
208             * Sets whether this layout set branch is private layout.
209             *
210             * @param privateLayout the private layout of this layout set branch
211             */
212            public void setPrivateLayout(boolean privateLayout);
213    
214            /**
215             * Returns the name of this layout set branch.
216             *
217             * @return the name of this layout set branch
218             */
219            @AutoEscape
220            public String getName();
221    
222            /**
223             * Sets the name of this layout set branch.
224             *
225             * @param name the name of this layout set branch
226             */
227            public void setName(String name);
228    
229            /**
230             * Returns the description of this layout set branch.
231             *
232             * @return the description of this layout set branch
233             */
234            @AutoEscape
235            public String getDescription();
236    
237            /**
238             * Sets the description of this layout set branch.
239             *
240             * @param description the description of this layout set branch
241             */
242            public void setDescription(String description);
243    
244            /**
245             * Returns the master of this layout set branch.
246             *
247             * @return the master of this layout set branch
248             */
249            public boolean getMaster();
250    
251            /**
252             * Returns <code>true</code> if this layout set branch is master.
253             *
254             * @return <code>true</code> if this layout set branch is master; <code>false</code> otherwise
255             */
256            public boolean isMaster();
257    
258            /**
259             * Sets whether this layout set branch is master.
260             *
261             * @param master the master of this layout set branch
262             */
263            public void setMaster(boolean master);
264    
265            /**
266             * Returns the logo of this layout set branch.
267             *
268             * @return the logo of this layout set branch
269             */
270            public boolean getLogo();
271    
272            /**
273             * Returns <code>true</code> if this layout set branch is logo.
274             *
275             * @return <code>true</code> if this layout set branch is logo; <code>false</code> otherwise
276             */
277            public boolean isLogo();
278    
279            /**
280             * Sets whether this layout set branch is logo.
281             *
282             * @param logo the logo of this layout set branch
283             */
284            public void setLogo(boolean logo);
285    
286            /**
287             * Returns the logo ID of this layout set branch.
288             *
289             * @return the logo ID of this layout set branch
290             */
291            public long getLogoId();
292    
293            /**
294             * Sets the logo ID of this layout set branch.
295             *
296             * @param logoId the logo ID of this layout set branch
297             */
298            public void setLogoId(long logoId);
299    
300            /**
301             * Returns the theme ID of this layout set branch.
302             *
303             * @return the theme ID of this layout set branch
304             */
305            @AutoEscape
306            public String getThemeId();
307    
308            /**
309             * Sets the theme ID of this layout set branch.
310             *
311             * @param themeId the theme ID of this layout set branch
312             */
313            public void setThemeId(String themeId);
314    
315            /**
316             * Returns the color scheme ID of this layout set branch.
317             *
318             * @return the color scheme ID of this layout set branch
319             */
320            @AutoEscape
321            public String getColorSchemeId();
322    
323            /**
324             * Sets the color scheme ID of this layout set branch.
325             *
326             * @param colorSchemeId the color scheme ID of this layout set branch
327             */
328            public void setColorSchemeId(String colorSchemeId);
329    
330            /**
331             * Returns the wap theme ID of this layout set branch.
332             *
333             * @return the wap theme ID of this layout set branch
334             */
335            @AutoEscape
336            public String getWapThemeId();
337    
338            /**
339             * Sets the wap theme ID of this layout set branch.
340             *
341             * @param wapThemeId the wap theme ID of this layout set branch
342             */
343            public void setWapThemeId(String wapThemeId);
344    
345            /**
346             * Returns the wap color scheme ID of this layout set branch.
347             *
348             * @return the wap color scheme ID of this layout set branch
349             */
350            @AutoEscape
351            public String getWapColorSchemeId();
352    
353            /**
354             * Sets the wap color scheme ID of this layout set branch.
355             *
356             * @param wapColorSchemeId the wap color scheme ID of this layout set branch
357             */
358            public void setWapColorSchemeId(String wapColorSchemeId);
359    
360            /**
361             * Returns the css of this layout set branch.
362             *
363             * @return the css of this layout set branch
364             */
365            @AutoEscape
366            public String getCss();
367    
368            /**
369             * Sets the css of this layout set branch.
370             *
371             * @param css the css of this layout set branch
372             */
373            public void setCss(String css);
374    
375            /**
376             * Returns the settings of this layout set branch.
377             *
378             * @return the settings of this layout set branch
379             */
380            @AutoEscape
381            public String getSettings();
382    
383            /**
384             * Sets the settings of this layout set branch.
385             *
386             * @param settings the settings of this layout set branch
387             */
388            public void setSettings(String settings);
389    
390            /**
391             * Returns the layout set prototype uuid of this layout set branch.
392             *
393             * @return the layout set prototype uuid of this layout set branch
394             */
395            @AutoEscape
396            public String getLayoutSetPrototypeUuid();
397    
398            /**
399             * Sets the layout set prototype uuid of this layout set branch.
400             *
401             * @param layoutSetPrototypeUuid the layout set prototype uuid of this layout set branch
402             */
403            public void setLayoutSetPrototypeUuid(String layoutSetPrototypeUuid);
404    
405            /**
406             * Returns the layout set prototype link enabled of this layout set branch.
407             *
408             * @return the layout set prototype link enabled of this layout set branch
409             */
410            public boolean getLayoutSetPrototypeLinkEnabled();
411    
412            /**
413             * Returns <code>true</code> if this layout set branch is layout set prototype link enabled.
414             *
415             * @return <code>true</code> if this layout set branch is layout set prototype link enabled; <code>false</code> otherwise
416             */
417            public boolean isLayoutSetPrototypeLinkEnabled();
418    
419            /**
420             * Sets whether this layout set branch is layout set prototype link enabled.
421             *
422             * @param layoutSetPrototypeLinkEnabled the layout set prototype link enabled of this layout set branch
423             */
424            public void setLayoutSetPrototypeLinkEnabled(
425                    boolean layoutSetPrototypeLinkEnabled);
426    
427            @Override
428            public boolean isNew();
429    
430            @Override
431            public void setNew(boolean n);
432    
433            @Override
434            public boolean isCachedModel();
435    
436            @Override
437            public void setCachedModel(boolean cachedModel);
438    
439            @Override
440            public boolean isEscapedModel();
441    
442            @Override
443            public Serializable getPrimaryKeyObj();
444    
445            @Override
446            public void setPrimaryKeyObj(Serializable primaryKeyObj);
447    
448            @Override
449            public ExpandoBridge getExpandoBridge();
450    
451            @Override
452            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
453    
454            @Override
455            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
456    
457            @Override
458            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
459    
460            @Override
461            public Object clone();
462    
463            @Override
464            public int compareTo(LayoutSetBranch layoutSetBranch);
465    
466            @Override
467            public int hashCode();
468    
469            @Override
470            public CacheModel<LayoutSetBranch> toCacheModel();
471    
472            @Override
473            public LayoutSetBranch toEscapedModel();
474    
475            @Override
476            public LayoutSetBranch toUnescapedModel();
477    
478            @Override
479            public String toString();
480    
481            @Override
482            public String toXmlString();
483    }