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