001 /** 002 * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 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 /** 025 * The base model interface for the Layout service. Represents a row in the "Layout" database table, with each column mapped to a property of this class. 026 * 027 * <p> 028 * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LayoutModelImpl} 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.LayoutImpl}. 029 * </p> 030 * 031 * @author Brian Wing Shun Chan 032 * @see Layout 033 * @see com.liferay.portal.model.impl.LayoutImpl 034 * @see com.liferay.portal.model.impl.LayoutModelImpl 035 * @generated 036 */ 037 public interface LayoutModel extends BaseModel<Layout> { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify or reference this interface directly. All methods that expect a layout model instance should use the {@link Layout} interface instead. 042 */ 043 044 /** 045 * Gets the primary key of this layout. 046 * 047 * @return the primary key of this layout 048 */ 049 public long getPrimaryKey(); 050 051 /** 052 * Sets the primary key of this layout 053 * 054 * @param primaryKey the primary key of this layout 055 */ 056 public void setPrimaryKey(long primaryKey); 057 058 /** 059 * Gets the uuid of this layout. 060 * 061 * @return the uuid of this layout 062 */ 063 @AutoEscape 064 public String getUuid(); 065 066 /** 067 * Sets the uuid of this layout. 068 * 069 * @param uuid the uuid of this layout 070 */ 071 public void setUuid(String uuid); 072 073 /** 074 * Gets the plid of this layout. 075 * 076 * @return the plid of this layout 077 */ 078 public long getPlid(); 079 080 /** 081 * Sets the plid of this layout. 082 * 083 * @param plid the plid of this layout 084 */ 085 public void setPlid(long plid); 086 087 /** 088 * Gets the group ID of this layout. 089 * 090 * @return the group ID of this layout 091 */ 092 public long getGroupId(); 093 094 /** 095 * Sets the group ID of this layout. 096 * 097 * @param groupId the group ID of this layout 098 */ 099 public void setGroupId(long groupId); 100 101 /** 102 * Gets the company ID of this layout. 103 * 104 * @return the company ID of this layout 105 */ 106 public long getCompanyId(); 107 108 /** 109 * Sets the company ID of this layout. 110 * 111 * @param companyId the company ID of this layout 112 */ 113 public void setCompanyId(long companyId); 114 115 /** 116 * Gets the private layout of this layout. 117 * 118 * @return the private layout of this layout 119 */ 120 public boolean getPrivateLayout(); 121 122 /** 123 * Determines if this layout is private layout. 124 * 125 * @return <code>true</code> if this layout is private layout; <code>false</code> otherwise 126 */ 127 public boolean isPrivateLayout(); 128 129 /** 130 * Sets whether this layout is private layout. 131 * 132 * @param privateLayout the private layout of this layout 133 */ 134 public void setPrivateLayout(boolean privateLayout); 135 136 /** 137 * Gets the layout ID of this layout. 138 * 139 * @return the layout ID of this layout 140 */ 141 public long getLayoutId(); 142 143 /** 144 * Sets the layout ID of this layout. 145 * 146 * @param layoutId the layout ID of this layout 147 */ 148 public void setLayoutId(long layoutId); 149 150 /** 151 * Gets the parent layout ID of this layout. 152 * 153 * @return the parent layout ID of this layout 154 */ 155 public long getParentLayoutId(); 156 157 /** 158 * Sets the parent layout ID of this layout. 159 * 160 * @param parentLayoutId the parent layout ID of this layout 161 */ 162 public void setParentLayoutId(long parentLayoutId); 163 164 /** 165 * Gets the name of this layout. 166 * 167 * @return the name of this layout 168 */ 169 @AutoEscape 170 public String getName(); 171 172 /** 173 * Sets the name of this layout. 174 * 175 * @param name the name of this layout 176 */ 177 public void setName(String name); 178 179 /** 180 * Gets the title of this layout. 181 * 182 * @return the title of this layout 183 */ 184 @AutoEscape 185 public String getTitle(); 186 187 /** 188 * Sets the title of this layout. 189 * 190 * @param title the title of this layout 191 */ 192 public void setTitle(String title); 193 194 /** 195 * Gets the description of this layout. 196 * 197 * @return the description of this layout 198 */ 199 @AutoEscape 200 public String getDescription(); 201 202 /** 203 * Sets the description of this layout. 204 * 205 * @param description the description of this layout 206 */ 207 public void setDescription(String description); 208 209 /** 210 * Gets the type of this layout. 211 * 212 * @return the type of this layout 213 */ 214 @AutoEscape 215 public String getType(); 216 217 /** 218 * Sets the type of this layout. 219 * 220 * @param type the type of this layout 221 */ 222 public void setType(String type); 223 224 /** 225 * Gets the type settings of this layout. 226 * 227 * @return the type settings of this layout 228 */ 229 @AutoEscape 230 public String getTypeSettings(); 231 232 /** 233 * Sets the type settings of this layout. 234 * 235 * @param typeSettings the type settings of this layout 236 */ 237 public void setTypeSettings(String typeSettings); 238 239 /** 240 * Gets the hidden of this layout. 241 * 242 * @return the hidden of this layout 243 */ 244 public boolean getHidden(); 245 246 /** 247 * Determines if this layout is hidden. 248 * 249 * @return <code>true</code> if this layout is hidden; <code>false</code> otherwise 250 */ 251 public boolean isHidden(); 252 253 /** 254 * Sets whether this layout is hidden. 255 * 256 * @param hidden the hidden of this layout 257 */ 258 public void setHidden(boolean hidden); 259 260 /** 261 * Gets the friendly u r l of this layout. 262 * 263 * @return the friendly u r l of this layout 264 */ 265 @AutoEscape 266 public String getFriendlyURL(); 267 268 /** 269 * Sets the friendly u r l of this layout. 270 * 271 * @param friendlyURL the friendly u r l of this layout 272 */ 273 public void setFriendlyURL(String friendlyURL); 274 275 /** 276 * Gets the icon image of this layout. 277 * 278 * @return the icon image of this layout 279 */ 280 public boolean getIconImage(); 281 282 /** 283 * Determines if this layout is icon image. 284 * 285 * @return <code>true</code> if this layout is icon image; <code>false</code> otherwise 286 */ 287 public boolean isIconImage(); 288 289 /** 290 * Sets whether this layout is icon image. 291 * 292 * @param iconImage the icon image of this layout 293 */ 294 public void setIconImage(boolean iconImage); 295 296 /** 297 * Gets the icon image ID of this layout. 298 * 299 * @return the icon image ID of this layout 300 */ 301 public long getIconImageId(); 302 303 /** 304 * Sets the icon image ID of this layout. 305 * 306 * @param iconImageId the icon image ID of this layout 307 */ 308 public void setIconImageId(long iconImageId); 309 310 /** 311 * Gets the theme ID of this layout. 312 * 313 * @return the theme ID of this layout 314 */ 315 @AutoEscape 316 public String getThemeId(); 317 318 /** 319 * Sets the theme ID of this layout. 320 * 321 * @param themeId the theme ID of this layout 322 */ 323 public void setThemeId(String themeId); 324 325 /** 326 * Gets the color scheme ID of this layout. 327 * 328 * @return the color scheme ID of this layout 329 */ 330 @AutoEscape 331 public String getColorSchemeId(); 332 333 /** 334 * Sets the color scheme ID of this layout. 335 * 336 * @param colorSchemeId the color scheme ID of this layout 337 */ 338 public void setColorSchemeId(String colorSchemeId); 339 340 /** 341 * Gets the wap theme ID of this layout. 342 * 343 * @return the wap theme ID of this layout 344 */ 345 @AutoEscape 346 public String getWapThemeId(); 347 348 /** 349 * Sets the wap theme ID of this layout. 350 * 351 * @param wapThemeId the wap theme ID of this layout 352 */ 353 public void setWapThemeId(String wapThemeId); 354 355 /** 356 * Gets the wap color scheme ID of this layout. 357 * 358 * @return the wap color scheme ID of this layout 359 */ 360 @AutoEscape 361 public String getWapColorSchemeId(); 362 363 /** 364 * Sets the wap color scheme ID of this layout. 365 * 366 * @param wapColorSchemeId the wap color scheme ID of this layout 367 */ 368 public void setWapColorSchemeId(String wapColorSchemeId); 369 370 /** 371 * Gets the css of this layout. 372 * 373 * @return the css of this layout 374 */ 375 @AutoEscape 376 public String getCss(); 377 378 /** 379 * Sets the css of this layout. 380 * 381 * @param css the css of this layout 382 */ 383 public void setCss(String css); 384 385 /** 386 * Gets the priority of this layout. 387 * 388 * @return the priority of this layout 389 */ 390 public int getPriority(); 391 392 /** 393 * Sets the priority of this layout. 394 * 395 * @param priority the priority of this layout 396 */ 397 public void setPriority(int priority); 398 399 /** 400 * Gets the layout prototype ID of this layout. 401 * 402 * @return the layout prototype ID of this layout 403 */ 404 public long getLayoutPrototypeId(); 405 406 /** 407 * Sets the layout prototype ID of this layout. 408 * 409 * @param layoutPrototypeId the layout prototype ID of this layout 410 */ 411 public void setLayoutPrototypeId(long layoutPrototypeId); 412 413 /** 414 * Gets the dl folder ID of this layout. 415 * 416 * @return the dl folder ID of this layout 417 */ 418 public long getDlFolderId(); 419 420 /** 421 * Sets the dl folder ID of this layout. 422 * 423 * @param dlFolderId the dl folder ID of this layout 424 */ 425 public void setDlFolderId(long dlFolderId); 426 427 public boolean isNew(); 428 429 public void setNew(boolean n); 430 431 public boolean isCachedModel(); 432 433 public void setCachedModel(boolean cachedModel); 434 435 public boolean isEscapedModel(); 436 437 public void setEscapedModel(boolean escapedModel); 438 439 public Serializable getPrimaryKeyObj(); 440 441 public void setPrimaryKeyObj(Serializable primaryKeyObj); 442 443 public ExpandoBridge getExpandoBridge(); 444 445 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 446 447 public Object clone(); 448 449 public int compareTo(Layout layout); 450 451 public int hashCode(); 452 453 public CacheModel<Layout> toCacheModel(); 454 455 public Layout toEscapedModel(); 456 457 public String toString(); 458 459 public String toXmlString(); 460 }