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