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