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.service; 016 017 import com.liferay.portal.kernel.annotation.Isolation; 018 import com.liferay.portal.kernel.annotation.Propagation; 019 import com.liferay.portal.kernel.annotation.Transactional; 020 import com.liferay.portal.kernel.exception.PortalException; 021 import com.liferay.portal.kernel.exception.SystemException; 022 023 /** 024 * The interface for the lock local service. 025 * 026 * <p> 027 * Never modify or reference this interface directly. Always use {@link LockLocalServiceUtil} to access the lock local service. Add custom service methods to {@link com.liferay.portal.service.impl.LockLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 028 * </p> 029 * 030 * <p> 031 * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM. 032 * </p> 033 * 034 * @author Brian Wing Shun Chan 035 * @see LockLocalServiceUtil 036 * @see com.liferay.portal.service.base.LockLocalServiceBaseImpl 037 * @see com.liferay.portal.service.impl.LockLocalServiceImpl 038 * @generated 039 */ 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface LockLocalService { 043 /** 044 * Adds the lock to the database. Also notifies the appropriate model listeners. 045 * 046 * @param lock the lock to add 047 * @return the lock that was added 048 * @throws SystemException if a system exception occurred 049 */ 050 public com.liferay.portal.model.Lock addLock( 051 com.liferay.portal.model.Lock lock) 052 throws com.liferay.portal.kernel.exception.SystemException; 053 054 /** 055 * Creates a new lock with the primary key. Does not add the lock to the database. 056 * 057 * @param lockId the primary key for the new lock 058 * @return the new lock 059 */ 060 public com.liferay.portal.model.Lock createLock(long lockId); 061 062 /** 063 * Deletes the lock with the primary key from the database. Also notifies the appropriate model listeners. 064 * 065 * @param lockId the primary key of the lock to delete 066 * @throws PortalException if a lock with the primary key could not be found 067 * @throws SystemException if a system exception occurred 068 */ 069 public void deleteLock(long lockId) 070 throws com.liferay.portal.kernel.exception.PortalException, 071 com.liferay.portal.kernel.exception.SystemException; 072 073 /** 074 * Deletes the lock from the database. Also notifies the appropriate model listeners. 075 * 076 * @param lock the lock to delete 077 * @throws SystemException if a system exception occurred 078 */ 079 public void deleteLock(com.liferay.portal.model.Lock lock) 080 throws com.liferay.portal.kernel.exception.SystemException; 081 082 /** 083 * Performs a dynamic query on the database and returns the matching rows. 084 * 085 * @param dynamicQuery the dynamic query to search with 086 * @return the matching rows 087 * @throws SystemException if a system exception occurred 088 */ 089 @SuppressWarnings("rawtypes") 090 public java.util.List dynamicQuery( 091 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 092 throws com.liferay.portal.kernel.exception.SystemException; 093 094 /** 095 * Performs a dynamic query on the database and returns a range of the matching rows. 096 * 097 * <p> 098 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 099 * </p> 100 * 101 * @param dynamicQuery the dynamic query to search with 102 * @param start the lower bound of the range of model instances to return 103 * @param end the upper bound of the range of model instances to return (not inclusive) 104 * @return the range of matching rows 105 * @throws SystemException if a system exception occurred 106 */ 107 @SuppressWarnings("rawtypes") 108 public java.util.List dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 110 int end) throws com.liferay.portal.kernel.exception.SystemException; 111 112 /** 113 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 114 * 115 * <p> 116 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 117 * </p> 118 * 119 * @param dynamicQuery the dynamic query to search with 120 * @param start the lower bound of the range of model instances to return 121 * @param end the upper bound of the range of model instances to return (not inclusive) 122 * @param orderByComparator the comparator to order the results by 123 * @return the ordered range of matching rows 124 * @throws SystemException if a system exception occurred 125 */ 126 @SuppressWarnings("rawtypes") 127 public java.util.List dynamicQuery( 128 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 129 int end, 130 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 131 throws com.liferay.portal.kernel.exception.SystemException; 132 133 /** 134 * Counts the number of rows that match the dynamic query. 135 * 136 * @param dynamicQuery the dynamic query to search with 137 * @return the number of rows that match the dynamic query 138 * @throws SystemException if a system exception occurred 139 */ 140 public long dynamicQueryCount( 141 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 142 throws com.liferay.portal.kernel.exception.SystemException; 143 144 /** 145 * Gets the lock with the primary key. 146 * 147 * @param lockId the primary key of the lock to get 148 * @return the lock 149 * @throws PortalException if a lock with the primary key could not be found 150 * @throws SystemException if a system exception occurred 151 */ 152 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 153 public com.liferay.portal.model.Lock getLock(long lockId) 154 throws com.liferay.portal.kernel.exception.PortalException, 155 com.liferay.portal.kernel.exception.SystemException; 156 157 /** 158 * Gets a range of all the locks. 159 * 160 * <p> 161 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 162 * </p> 163 * 164 * @param start the lower bound of the range of locks to return 165 * @param end the upper bound of the range of locks to return (not inclusive) 166 * @return the range of locks 167 * @throws SystemException if a system exception occurred 168 */ 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public java.util.List<com.liferay.portal.model.Lock> getLocks(int start, 171 int end) throws com.liferay.portal.kernel.exception.SystemException; 172 173 /** 174 * Gets the number of locks. 175 * 176 * @return the number of locks 177 * @throws SystemException if a system exception occurred 178 */ 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public int getLocksCount() 181 throws com.liferay.portal.kernel.exception.SystemException; 182 183 /** 184 * Updates the lock in the database. Also notifies the appropriate model listeners. 185 * 186 * @param lock the lock to update 187 * @return the lock that was updated 188 * @throws SystemException if a system exception occurred 189 */ 190 public com.liferay.portal.model.Lock updateLock( 191 com.liferay.portal.model.Lock lock) 192 throws com.liferay.portal.kernel.exception.SystemException; 193 194 /** 195 * Updates the lock in the database. Also notifies the appropriate model listeners. 196 * 197 * @param lock the lock to update 198 * @param merge whether to merge the lock with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 199 * @return the lock that was updated 200 * @throws SystemException if a system exception occurred 201 */ 202 public com.liferay.portal.model.Lock updateLock( 203 com.liferay.portal.model.Lock lock, boolean merge) 204 throws com.liferay.portal.kernel.exception.SystemException; 205 206 public void clear() 207 throws com.liferay.portal.kernel.exception.SystemException; 208 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public com.liferay.portal.model.Lock getLock(java.lang.String className, 211 long key) 212 throws com.liferay.portal.kernel.exception.PortalException, 213 com.liferay.portal.kernel.exception.SystemException; 214 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public com.liferay.portal.model.Lock getLock(java.lang.String className, 217 java.lang.String key) 218 throws com.liferay.portal.kernel.exception.PortalException, 219 com.liferay.portal.kernel.exception.SystemException; 220 221 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 222 public boolean hasLock(long userId, java.lang.String className, long key) 223 throws com.liferay.portal.kernel.exception.PortalException, 224 com.liferay.portal.kernel.exception.SystemException; 225 226 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 227 public boolean hasLock(long userId, java.lang.String className, 228 java.lang.String key) 229 throws com.liferay.portal.kernel.exception.PortalException, 230 com.liferay.portal.kernel.exception.SystemException; 231 232 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 233 public boolean isLocked(java.lang.String className, long key) 234 throws com.liferay.portal.kernel.exception.PortalException, 235 com.liferay.portal.kernel.exception.SystemException; 236 237 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 238 public boolean isLocked(java.lang.String className, java.lang.String key) 239 throws com.liferay.portal.kernel.exception.PortalException, 240 com.liferay.portal.kernel.exception.SystemException; 241 242 public com.liferay.portal.model.Lock lock(long userId, 243 java.lang.String className, long key, java.lang.String owner, 244 boolean inheritable, long expirationTime) 245 throws com.liferay.portal.kernel.exception.PortalException, 246 com.liferay.portal.kernel.exception.SystemException; 247 248 public com.liferay.portal.model.Lock lock(long userId, 249 java.lang.String className, java.lang.String key, 250 java.lang.String owner, boolean inheritable, long expirationTime) 251 throws com.liferay.portal.kernel.exception.PortalException, 252 com.liferay.portal.kernel.exception.SystemException; 253 254 public com.liferay.portal.model.Lock refresh(java.lang.String uuid, 255 long expirationTime) 256 throws com.liferay.portal.kernel.exception.PortalException, 257 com.liferay.portal.kernel.exception.SystemException; 258 259 public void unlock(java.lang.String className, long key) 260 throws com.liferay.portal.kernel.exception.SystemException; 261 262 public void unlock(java.lang.String className, java.lang.String key) 263 throws com.liferay.portal.kernel.exception.SystemException; 264 }