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