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.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.transaction.Isolation; 022 import com.liferay.portal.kernel.transaction.Propagation; 023 import com.liferay.portal.kernel.transaction.Transactional; 024 025 /** 026 * Provides the local service interface for Repository. Methods of this 027 * service will not have security checks based on the propagated JAAS 028 * credentials because this service can only be accessed from within the same 029 * VM. 030 * 031 * @author Brian Wing Shun Chan 032 * @see RepositoryLocalServiceUtil 033 * @see com.liferay.portal.service.base.RepositoryLocalServiceBaseImpl 034 * @see com.liferay.portal.service.impl.RepositoryLocalServiceImpl 035 * @generated 036 */ 037 @ProviderType 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface RepositoryLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link RepositoryLocalServiceUtil} to access the repository local service. Add custom service methods to {@link com.liferay.portal.service.impl.RepositoryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Adds the repository to the database. Also notifies the appropriate model listeners. 050 * 051 * @param repository the repository 052 * @return the repository that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portal.model.Repository addRepository( 056 com.liferay.portal.model.Repository repository) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new repository with the primary key. Does not add the repository to the database. 061 * 062 * @param repositoryId the primary key for the new repository 063 * @return the new repository 064 */ 065 public com.liferay.portal.model.Repository createRepository( 066 long repositoryId); 067 068 /** 069 * Deletes the repository with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param repositoryId the primary key of the repository 072 * @return the repository that was removed 073 * @throws PortalException if a repository with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portal.model.Repository deleteRepository( 077 long repositoryId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the repository from the database. Also notifies the appropriate model listeners. 083 * 084 * @param repository the repository 085 * @return the repository that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portal.model.Repository deleteRepository( 089 com.liferay.portal.model.Repository repository) 090 throws com.liferay.portal.kernel.exception.SystemException; 091 092 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 093 094 /** 095 * Performs a dynamic query on the database and returns the matching rows. 096 * 097 * @param dynamicQuery the dynamic query 098 * @return the matching rows 099 * @throws SystemException if a system exception occurred 100 */ 101 @SuppressWarnings("rawtypes") 102 public java.util.List dynamicQuery( 103 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 104 throws com.liferay.portal.kernel.exception.SystemException; 105 106 /** 107 * Performs a dynamic query on the database and returns a range of the matching rows. 108 * 109 * <p> 110 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.RepositoryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 111 * </p> 112 * 113 * @param dynamicQuery the dynamic query 114 * @param start the lower bound of the range of model instances 115 * @param end the upper bound of the range of model instances (not inclusive) 116 * @return the range of matching rows 117 * @throws SystemException if a system exception occurred 118 */ 119 @SuppressWarnings("rawtypes") 120 public java.util.List dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end) throws com.liferay.portal.kernel.exception.SystemException; 123 124 /** 125 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 126 * 127 * <p> 128 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.RepositoryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 129 * </p> 130 * 131 * @param dynamicQuery the dynamic query 132 * @param start the lower bound of the range of model instances 133 * @param end the upper bound of the range of model instances (not inclusive) 134 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 135 * @return the ordered range of matching rows 136 * @throws SystemException if a system exception occurred 137 */ 138 @SuppressWarnings("rawtypes") 139 public java.util.List dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 143 throws com.liferay.portal.kernel.exception.SystemException; 144 145 /** 146 * Returns the number of rows that match the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows that match the dynamic query 150 * @throws SystemException if a system exception occurred 151 */ 152 public long dynamicQueryCount( 153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 154 throws com.liferay.portal.kernel.exception.SystemException; 155 156 /** 157 * Returns the number of rows that match the dynamic query. 158 * 159 * @param dynamicQuery the dynamic query 160 * @param projection the projection to apply to the query 161 * @return the number of rows that match the dynamic query 162 * @throws SystemException if a system exception occurred 163 */ 164 public long dynamicQueryCount( 165 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 166 com.liferay.portal.kernel.dao.orm.Projection projection) 167 throws com.liferay.portal.kernel.exception.SystemException; 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.model.Repository fetchRepository( 171 long repositoryId) 172 throws com.liferay.portal.kernel.exception.SystemException; 173 174 /** 175 * Returns the repository with the matching UUID and company. 176 * 177 * @param uuid the repository's UUID 178 * @param companyId the primary key of the company 179 * @return the matching repository, or <code>null</code> if a matching repository could not be found 180 * @throws SystemException if a system exception occurred 181 */ 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.model.Repository fetchRepositoryByUuidAndCompanyId( 184 java.lang.String uuid, long companyId) 185 throws com.liferay.portal.kernel.exception.SystemException; 186 187 /** 188 * Returns the repository matching the UUID and group. 189 * 190 * @param uuid the repository's UUID 191 * @param groupId the primary key of the group 192 * @return the matching repository, or <code>null</code> if a matching repository could not be found 193 * @throws SystemException if a system exception occurred 194 */ 195 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 196 public com.liferay.portal.model.Repository fetchRepositoryByUuidAndGroupId( 197 java.lang.String uuid, long groupId) 198 throws com.liferay.portal.kernel.exception.SystemException; 199 200 /** 201 * Returns the repository with the primary key. 202 * 203 * @param repositoryId the primary key of the repository 204 * @return the repository 205 * @throws PortalException if a repository with the primary key could not be found 206 * @throws SystemException if a system exception occurred 207 */ 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public com.liferay.portal.model.Repository getRepository(long repositoryId) 210 throws com.liferay.portal.kernel.exception.PortalException, 211 com.liferay.portal.kernel.exception.SystemException; 212 213 @Override 214 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 215 public com.liferay.portal.model.PersistedModel getPersistedModel( 216 java.io.Serializable primaryKeyObj) 217 throws com.liferay.portal.kernel.exception.PortalException, 218 com.liferay.portal.kernel.exception.SystemException; 219 220 /** 221 * Returns the repository with the matching UUID and company. 222 * 223 * @param uuid the repository's UUID 224 * @param companyId the primary key of the company 225 * @return the matching repository 226 * @throws PortalException if a matching repository could not be found 227 * @throws SystemException if a system exception occurred 228 */ 229 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 230 public com.liferay.portal.model.Repository getRepositoryByUuidAndCompanyId( 231 java.lang.String uuid, long companyId) 232 throws com.liferay.portal.kernel.exception.PortalException, 233 com.liferay.portal.kernel.exception.SystemException; 234 235 /** 236 * Returns the repository matching the UUID and group. 237 * 238 * @param uuid the repository's UUID 239 * @param groupId the primary key of the group 240 * @return the matching repository 241 * @throws PortalException if a matching repository could not be found 242 * @throws SystemException if a system exception occurred 243 */ 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public com.liferay.portal.model.Repository getRepositoryByUuidAndGroupId( 246 java.lang.String uuid, long groupId) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException; 249 250 /** 251 * Returns a range of all the repositories. 252 * 253 * <p> 254 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.RepositoryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 255 * </p> 256 * 257 * @param start the lower bound of the range of repositories 258 * @param end the upper bound of the range of repositories (not inclusive) 259 * @return the range of repositories 260 * @throws SystemException if a system exception occurred 261 */ 262 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 263 public java.util.List<com.liferay.portal.model.Repository> getRepositories( 264 int start, int end) 265 throws com.liferay.portal.kernel.exception.SystemException; 266 267 /** 268 * Returns the number of repositories. 269 * 270 * @return the number of repositories 271 * @throws SystemException if a system exception occurred 272 */ 273 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 274 public int getRepositoriesCount() 275 throws com.liferay.portal.kernel.exception.SystemException; 276 277 /** 278 * Updates the repository in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 279 * 280 * @param repository the repository 281 * @return the repository that was updated 282 * @throws SystemException if a system exception occurred 283 */ 284 public com.liferay.portal.model.Repository updateRepository( 285 com.liferay.portal.model.Repository repository) 286 throws com.liferay.portal.kernel.exception.SystemException; 287 288 /** 289 * Returns the Spring bean ID for this bean. 290 * 291 * @return the Spring bean ID for this bean 292 */ 293 public java.lang.String getBeanIdentifier(); 294 295 /** 296 * Sets the Spring bean ID for this bean. 297 * 298 * @param beanIdentifier the Spring bean ID for this bean 299 */ 300 public void setBeanIdentifier(java.lang.String beanIdentifier); 301 302 public com.liferay.portal.model.Repository addRepository(long userId, 303 long groupId, long classNameId, long parentFolderId, 304 java.lang.String name, java.lang.String description, 305 java.lang.String portletId, 306 com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties, 307 boolean hidden, com.liferay.portal.service.ServiceContext serviceContext) 308 throws com.liferay.portal.kernel.exception.PortalException, 309 com.liferay.portal.kernel.exception.SystemException; 310 311 /** 312 * @deprecated As of 6.2.0, replaced by {@link #addRepository(long, long, 313 long, long, String, String, String, UnicodeProperties, 314 boolean, ServiceContext)} 315 */ 316 public com.liferay.portal.model.Repository addRepository(long userId, 317 long groupId, long classNameId, long parentFolderId, 318 java.lang.String name, java.lang.String description, 319 java.lang.String portletId, 320 com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties, 321 com.liferay.portal.service.ServiceContext serviceContext) 322 throws com.liferay.portal.kernel.exception.PortalException, 323 com.liferay.portal.kernel.exception.SystemException; 324 325 public void checkRepository(long repositoryId) 326 throws com.liferay.portal.kernel.exception.SystemException; 327 328 public void deleteRepositories(long groupId) 329 throws com.liferay.portal.kernel.exception.PortalException, 330 com.liferay.portal.kernel.exception.SystemException; 331 332 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 333 public com.liferay.portal.model.Repository fetchRepository(long groupId, 334 java.lang.String portletId) 335 throws com.liferay.portal.kernel.exception.SystemException; 336 337 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 338 public com.liferay.portal.model.Repository fetchRepository(long groupId, 339 java.lang.String name, java.lang.String portletId) 340 throws com.liferay.portal.kernel.exception.SystemException; 341 342 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 343 public com.liferay.portal.kernel.repository.LocalRepository getLocalRepositoryImpl( 344 long repositoryId) 345 throws com.liferay.portal.kernel.exception.PortalException, 346 com.liferay.portal.kernel.exception.SystemException; 347 348 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 349 public com.liferay.portal.kernel.repository.LocalRepository getLocalRepositoryImpl( 350 long folderId, long fileEntryId, long fileVersionId) 351 throws com.liferay.portal.kernel.exception.PortalException, 352 com.liferay.portal.kernel.exception.SystemException; 353 354 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 355 public com.liferay.portal.model.Repository getRepository(long groupId, 356 java.lang.String portletId) 357 throws com.liferay.portal.kernel.exception.PortalException, 358 com.liferay.portal.kernel.exception.SystemException; 359 360 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 361 public com.liferay.portal.model.Repository getRepository(long groupId, 362 java.lang.String name, java.lang.String portletId) 363 throws com.liferay.portal.kernel.exception.PortalException, 364 com.liferay.portal.kernel.exception.SystemException; 365 366 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 367 public com.liferay.portal.kernel.repository.Repository getRepositoryImpl( 368 long repositoryId) 369 throws com.liferay.portal.kernel.exception.PortalException, 370 com.liferay.portal.kernel.exception.SystemException; 371 372 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 373 public com.liferay.portal.kernel.repository.Repository getRepositoryImpl( 374 long folderId, long fileEntryId, long fileVersionId) 375 throws com.liferay.portal.kernel.exception.PortalException, 376 com.liferay.portal.kernel.exception.SystemException; 377 378 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 379 public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties( 380 long repositoryId) 381 throws com.liferay.portal.kernel.exception.PortalException, 382 com.liferay.portal.kernel.exception.SystemException; 383 384 public void updateRepository(long repositoryId, java.lang.String name, 385 java.lang.String description) 386 throws com.liferay.portal.kernel.exception.PortalException, 387 com.liferay.portal.kernel.exception.SystemException; 388 }