001 /** 002 * Copyright (c) 2000-present 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.service.ServiceContext; 021 022 import com.liferay.portlet.expando.model.ExpandoBridge; 023 024 import java.io.Serializable; 025 026 import java.util.Date; 027 028 /** 029 * The base model interface for the Lock service. Represents a row in the "Lock_" database table, with each column mapped to a property of this class. 030 * 031 * <p> 032 * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LockModelImpl} 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.LockImpl}. 033 * </p> 034 * 035 * @author Brian Wing Shun Chan 036 * @see Lock 037 * @see com.liferay.portal.model.impl.LockImpl 038 * @see com.liferay.portal.model.impl.LockModelImpl 039 * @generated 040 */ 041 @ProviderType 042 public interface LockModel extends BaseModel<Lock>, MVCCModel { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. All methods that expect a lock model instance should use the {@link Lock} interface instead. 047 */ 048 049 /** 050 * Returns the primary key of this lock. 051 * 052 * @return the primary key of this lock 053 */ 054 public long getPrimaryKey(); 055 056 /** 057 * Sets the primary key of this lock. 058 * 059 * @param primaryKey the primary key of this lock 060 */ 061 public void setPrimaryKey(long primaryKey); 062 063 /** 064 * Returns the mvcc version of this lock. 065 * 066 * @return the mvcc version of this lock 067 */ 068 @Override 069 public long getMvccVersion(); 070 071 /** 072 * Sets the mvcc version of this lock. 073 * 074 * @param mvccVersion the mvcc version of this lock 075 */ 076 @Override 077 public void setMvccVersion(long mvccVersion); 078 079 /** 080 * Returns the uuid of this lock. 081 * 082 * @return the uuid of this lock 083 */ 084 @AutoEscape 085 public String getUuid(); 086 087 /** 088 * Sets the uuid of this lock. 089 * 090 * @param uuid the uuid of this lock 091 */ 092 public void setUuid(String uuid); 093 094 /** 095 * Returns the lock ID of this lock. 096 * 097 * @return the lock ID of this lock 098 */ 099 public long getLockId(); 100 101 /** 102 * Sets the lock ID of this lock. 103 * 104 * @param lockId the lock ID of this lock 105 */ 106 public void setLockId(long lockId); 107 108 /** 109 * Returns the company ID of this lock. 110 * 111 * @return the company ID of this lock 112 */ 113 public long getCompanyId(); 114 115 /** 116 * Sets the company ID of this lock. 117 * 118 * @param companyId the company ID of this lock 119 */ 120 public void setCompanyId(long companyId); 121 122 /** 123 * Returns the user ID of this lock. 124 * 125 * @return the user ID of this lock 126 */ 127 public long getUserId(); 128 129 /** 130 * Sets the user ID of this lock. 131 * 132 * @param userId the user ID of this lock 133 */ 134 public void setUserId(long userId); 135 136 /** 137 * Returns the user uuid of this lock. 138 * 139 * @return the user uuid of this lock 140 */ 141 public String getUserUuid(); 142 143 /** 144 * Sets the user uuid of this lock. 145 * 146 * @param userUuid the user uuid of this lock 147 */ 148 public void setUserUuid(String userUuid); 149 150 /** 151 * Returns the user name of this lock. 152 * 153 * @return the user name of this lock 154 */ 155 @AutoEscape 156 public String getUserName(); 157 158 /** 159 * Sets the user name of this lock. 160 * 161 * @param userName the user name of this lock 162 */ 163 public void setUserName(String userName); 164 165 /** 166 * Returns the create date of this lock. 167 * 168 * @return the create date of this lock 169 */ 170 public Date getCreateDate(); 171 172 /** 173 * Sets the create date of this lock. 174 * 175 * @param createDate the create date of this lock 176 */ 177 public void setCreateDate(Date createDate); 178 179 /** 180 * Returns the class name of this lock. 181 * 182 * @return the class name of this lock 183 */ 184 @AutoEscape 185 public String getClassName(); 186 187 /** 188 * Sets the class name of this lock. 189 * 190 * @param className the class name of this lock 191 */ 192 public void setClassName(String className); 193 194 /** 195 * Returns the key of this lock. 196 * 197 * @return the key of this lock 198 */ 199 @AutoEscape 200 public String getKey(); 201 202 /** 203 * Sets the key of this lock. 204 * 205 * @param key the key of this lock 206 */ 207 public void setKey(String key); 208 209 /** 210 * Returns the owner of this lock. 211 * 212 * @return the owner of this lock 213 */ 214 @AutoEscape 215 public String getOwner(); 216 217 /** 218 * Sets the owner of this lock. 219 * 220 * @param owner the owner of this lock 221 */ 222 public void setOwner(String owner); 223 224 /** 225 * Returns the inheritable of this lock. 226 * 227 * @return the inheritable of this lock 228 */ 229 public boolean getInheritable(); 230 231 /** 232 * Returns <code>true</code> if this lock is inheritable. 233 * 234 * @return <code>true</code> if this lock is inheritable; <code>false</code> otherwise 235 */ 236 public boolean isInheritable(); 237 238 /** 239 * Sets whether this lock is inheritable. 240 * 241 * @param inheritable the inheritable of this lock 242 */ 243 public void setInheritable(boolean inheritable); 244 245 /** 246 * Returns the expiration date of this lock. 247 * 248 * @return the expiration date of this lock 249 */ 250 public Date getExpirationDate(); 251 252 /** 253 * Sets the expiration date of this lock. 254 * 255 * @param expirationDate the expiration date of this lock 256 */ 257 public void setExpirationDate(Date expirationDate); 258 259 @Override 260 public boolean isNew(); 261 262 @Override 263 public void setNew(boolean n); 264 265 @Override 266 public boolean isCachedModel(); 267 268 @Override 269 public void setCachedModel(boolean cachedModel); 270 271 @Override 272 public boolean isEscapedModel(); 273 274 @Override 275 public Serializable getPrimaryKeyObj(); 276 277 @Override 278 public void setPrimaryKeyObj(Serializable primaryKeyObj); 279 280 @Override 281 public ExpandoBridge getExpandoBridge(); 282 283 @Override 284 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 285 286 @Override 287 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 288 289 @Override 290 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 291 292 @Override 293 public Object clone(); 294 295 @Override 296 public int compareTo(com.liferay.portal.model.Lock lock); 297 298 @Override 299 public int hashCode(); 300 301 @Override 302 public CacheModel<com.liferay.portal.model.Lock> toCacheModel(); 303 304 @Override 305 public com.liferay.portal.model.Lock toEscapedModel(); 306 307 @Override 308 public com.liferay.portal.model.Lock toUnescapedModel(); 309 310 @Override 311 public String toString(); 312 313 @Override 314 public String toXmlString(); 315 }