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