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