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