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.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.service.ServiceContext;
020    
021    import com.liferay.portlet.expando.model.ExpandoBridge;
022    
023    import java.io.Serializable;
024    
025    /**
026     * The base model interface for the LayoutBranch service. Represents a row in the "LayoutBranch" database table, with each column mapped to a property of this class.
027     *
028     * <p>
029     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LayoutBranchModelImpl} 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.LayoutBranchImpl}.
030     * </p>
031     *
032     * @author Brian Wing Shun Chan
033     * @see LayoutBranch
034     * @see com.liferay.portal.model.impl.LayoutBranchImpl
035     * @see com.liferay.portal.model.impl.LayoutBranchModelImpl
036     * @generated
037     */
038    public interface LayoutBranchModel extends BaseModel<LayoutBranch> {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * Never modify or reference this interface directly. All methods that expect a layout branch model instance should use the {@link LayoutBranch} interface instead.
043             */
044    
045            /**
046             * Returns the primary key of this layout branch.
047             *
048             * @return the primary key of this layout branch
049             */
050            public long getPrimaryKey();
051    
052            /**
053             * Sets the primary key of this layout branch.
054             *
055             * @param primaryKey the primary key of this layout branch
056             */
057            public void setPrimaryKey(long primaryKey);
058    
059            /**
060             * Returns the layout branch ID of this layout branch.
061             *
062             * @return the layout branch ID of this layout branch
063             */
064            public long getLayoutBranchId();
065    
066            /**
067             * Sets the layout branch ID of this layout branch.
068             *
069             * @param LayoutBranchId the layout branch ID of this layout branch
070             */
071            public void setLayoutBranchId(long LayoutBranchId);
072    
073            /**
074             * Returns the group ID of this layout branch.
075             *
076             * @return the group ID of this layout branch
077             */
078            public long getGroupId();
079    
080            /**
081             * Sets the group ID of this layout branch.
082             *
083             * @param groupId the group ID of this layout branch
084             */
085            public void setGroupId(long groupId);
086    
087            /**
088             * Returns the company ID of this layout branch.
089             *
090             * @return the company ID of this layout branch
091             */
092            public long getCompanyId();
093    
094            /**
095             * Sets the company ID of this layout branch.
096             *
097             * @param companyId the company ID of this layout branch
098             */
099            public void setCompanyId(long companyId);
100    
101            /**
102             * Returns the user ID of this layout branch.
103             *
104             * @return the user ID of this layout branch
105             */
106            public long getUserId();
107    
108            /**
109             * Sets the user ID of this layout branch.
110             *
111             * @param userId the user ID of this layout branch
112             */
113            public void setUserId(long userId);
114    
115            /**
116             * Returns the user uuid of this layout branch.
117             *
118             * @return the user uuid of this layout branch
119             * @throws SystemException if a system exception occurred
120             */
121            public String getUserUuid() throws SystemException;
122    
123            /**
124             * Sets the user uuid of this layout branch.
125             *
126             * @param userUuid the user uuid of this layout branch
127             */
128            public void setUserUuid(String userUuid);
129    
130            /**
131             * Returns the user name of this layout branch.
132             *
133             * @return the user name of this layout branch
134             */
135            @AutoEscape
136            public String getUserName();
137    
138            /**
139             * Sets the user name of this layout branch.
140             *
141             * @param userName the user name of this layout branch
142             */
143            public void setUserName(String userName);
144    
145            /**
146             * Returns the layout set branch ID of this layout branch.
147             *
148             * @return the layout set branch ID of this layout branch
149             */
150            public long getLayoutSetBranchId();
151    
152            /**
153             * Sets the layout set branch ID of this layout branch.
154             *
155             * @param layoutSetBranchId the layout set branch ID of this layout branch
156             */
157            public void setLayoutSetBranchId(long layoutSetBranchId);
158    
159            /**
160             * Returns the plid of this layout branch.
161             *
162             * @return the plid of this layout branch
163             */
164            public long getPlid();
165    
166            /**
167             * Sets the plid of this layout branch.
168             *
169             * @param plid the plid of this layout branch
170             */
171            public void setPlid(long plid);
172    
173            /**
174             * Returns the name of this layout branch.
175             *
176             * @return the name of this layout branch
177             */
178            @AutoEscape
179            public String getName();
180    
181            /**
182             * Sets the name of this layout branch.
183             *
184             * @param name the name of this layout branch
185             */
186            public void setName(String name);
187    
188            /**
189             * Returns the description of this layout branch.
190             *
191             * @return the description of this layout branch
192             */
193            @AutoEscape
194            public String getDescription();
195    
196            /**
197             * Sets the description of this layout branch.
198             *
199             * @param description the description of this layout branch
200             */
201            public void setDescription(String description);
202    
203            /**
204             * Returns the master of this layout branch.
205             *
206             * @return the master of this layout branch
207             */
208            public boolean getMaster();
209    
210            /**
211             * Returns <code>true</code> if this layout branch is master.
212             *
213             * @return <code>true</code> if this layout branch is master; <code>false</code> otherwise
214             */
215            public boolean isMaster();
216    
217            /**
218             * Sets whether this layout branch is master.
219             *
220             * @param master the master of this layout branch
221             */
222            public void setMaster(boolean master);
223    
224            public boolean isNew();
225    
226            public void setNew(boolean n);
227    
228            public boolean isCachedModel();
229    
230            public void setCachedModel(boolean cachedModel);
231    
232            public boolean isEscapedModel();
233    
234            public Serializable getPrimaryKeyObj();
235    
236            public void setPrimaryKeyObj(Serializable primaryKeyObj);
237    
238            public ExpandoBridge getExpandoBridge();
239    
240            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
241    
242            public Object clone();
243    
244            public int compareTo(LayoutBranch layoutBranch);
245    
246            public int hashCode();
247    
248            public CacheModel<LayoutBranch> toCacheModel();
249    
250            public LayoutBranch toEscapedModel();
251    
252            public LayoutBranch toUnescapedModel();
253    
254            public String toString();
255    
256            public String toXmlString();
257    }