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.documentlibrary.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 DLFileRank service. Represents a row in the "DLFileRank" 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.documentlibrary.model.impl.DLFileRankModelImpl} 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.documentlibrary.model.impl.DLFileRankImpl}. 036 * </p> 037 * 038 * @author Brian Wing Shun Chan 039 * @see DLFileRank 040 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileRankImpl 041 * @see com.liferay.portlet.documentlibrary.model.impl.DLFileRankModelImpl 042 * @generated 043 */ 044 public interface DLFileRankModel extends BaseModel<DLFileRank>, GroupedModel, 045 StagedModel { 046 /* 047 * NOTE FOR DEVELOPERS: 048 * 049 * Never modify or reference this interface directly. All methods that expect a document library file rank model instance should use the {@link DLFileRank} interface instead. 050 */ 051 052 /** 053 * Returns the primary key of this document library file rank. 054 * 055 * @return the primary key of this document library file rank 056 */ 057 public long getPrimaryKey(); 058 059 /** 060 * Sets the primary key of this document library file rank. 061 * 062 * @param primaryKey the primary key of this document library file rank 063 */ 064 public void setPrimaryKey(long primaryKey); 065 066 /** 067 * Returns the uuid of this document library file rank. 068 * 069 * @return the uuid of this document library file rank 070 */ 071 @AutoEscape 072 public String getUuid(); 073 074 /** 075 * Sets the uuid of this document library file rank. 076 * 077 * @param uuid the uuid of this document library file rank 078 */ 079 public void setUuid(String uuid); 080 081 /** 082 * Returns the file rank ID of this document library file rank. 083 * 084 * @return the file rank ID of this document library file rank 085 */ 086 public long getFileRankId(); 087 088 /** 089 * Sets the file rank ID of this document library file rank. 090 * 091 * @param fileRankId the file rank ID of this document library file rank 092 */ 093 public void setFileRankId(long fileRankId); 094 095 /** 096 * Returns the group ID of this document library file rank. 097 * 098 * @return the group ID of this document library file rank 099 */ 100 public long getGroupId(); 101 102 /** 103 * Sets the group ID of this document library file rank. 104 * 105 * @param groupId the group ID of this document library file rank 106 */ 107 public void setGroupId(long groupId); 108 109 /** 110 * Returns the company ID of this document library file rank. 111 * 112 * @return the company ID of this document library file rank 113 */ 114 public long getCompanyId(); 115 116 /** 117 * Sets the company ID of this document library file rank. 118 * 119 * @param companyId the company ID of this document library file rank 120 */ 121 public void setCompanyId(long companyId); 122 123 /** 124 * Returns the user ID of this document library file rank. 125 * 126 * @return the user ID of this document library file rank 127 */ 128 public long getUserId(); 129 130 /** 131 * Sets the user ID of this document library file rank. 132 * 133 * @param userId the user ID of this document library file rank 134 */ 135 public void setUserId(long userId); 136 137 /** 138 * Returns the user uuid of this document library file rank. 139 * 140 * @return the user uuid of this document library file rank 141 * @throws SystemException if a system exception occurred 142 */ 143 public String getUserUuid() throws SystemException; 144 145 /** 146 * Sets the user uuid of this document library file rank. 147 * 148 * @param userUuid the user uuid of this document library file rank 149 */ 150 public void setUserUuid(String userUuid); 151 152 /** 153 * Returns the user name of this document library file rank. 154 * 155 * @return the user name of this document library file rank 156 */ 157 @AutoEscape 158 public String getUserName(); 159 160 /** 161 * Sets the user name of this document library file rank. 162 * 163 * @param userName the user name of this document library file rank 164 */ 165 public void setUserName(String userName); 166 167 /** 168 * Returns the create date of this document library file rank. 169 * 170 * @return the create date of this document library file rank 171 */ 172 public Date getCreateDate(); 173 174 /** 175 * Sets the create date of this document library file rank. 176 * 177 * @param createDate the create date of this document library file rank 178 */ 179 public void setCreateDate(Date createDate); 180 181 /** 182 * Returns the modified date of this document library file rank. 183 * 184 * @return the modified date of this document library file rank 185 */ 186 public Date getModifiedDate(); 187 188 /** 189 * Sets the modified date of this document library file rank. 190 * 191 * @param modifiedDate the modified date of this document library file rank 192 */ 193 public void setModifiedDate(Date modifiedDate); 194 195 /** 196 * Returns the file entry ID of this document library file rank. 197 * 198 * @return the file entry ID of this document library file rank 199 */ 200 public long getFileEntryId(); 201 202 /** 203 * Sets the file entry ID of this document library file rank. 204 * 205 * @param fileEntryId the file entry ID of this document library file rank 206 */ 207 public void setFileEntryId(long fileEntryId); 208 209 /** 210 * Returns the active of this document library file rank. 211 * 212 * @return the active of this document library file rank 213 */ 214 public boolean getActive(); 215 216 /** 217 * Returns <code>true</code> if this document library file rank is active. 218 * 219 * @return <code>true</code> if this document library file rank is active; <code>false</code> otherwise 220 */ 221 public boolean isActive(); 222 223 /** 224 * Sets whether this document library file rank is active. 225 * 226 * @param active the active of this document library file rank 227 */ 228 public void setActive(boolean active); 229 230 public boolean isNew(); 231 232 public void setNew(boolean n); 233 234 public boolean isCachedModel(); 235 236 public void setCachedModel(boolean cachedModel); 237 238 public boolean isEscapedModel(); 239 240 public Serializable getPrimaryKeyObj(); 241 242 public void setPrimaryKeyObj(Serializable primaryKeyObj); 243 244 public ExpandoBridge getExpandoBridge(); 245 246 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 247 248 public Object clone(); 249 250 public int compareTo(DLFileRank dlFileRank); 251 252 public int hashCode(); 253 254 public CacheModel<DLFileRank> toCacheModel(); 255 256 public DLFileRank toEscapedModel(); 257 258 public DLFileRank toUnescapedModel(); 259 260 public String toString(); 261 262 public String toXmlString(); 263 }