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 com.liferay.portal.kernel.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 023 /** 024 * The interface for the repository local service. 025 * 026 * <p> 027 * 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. 028 * </p> 029 * 030 * @author Brian Wing Shun Chan 031 * @see RepositoryLocalServiceUtil 032 * @see com.liferay.portal.service.base.RepositoryLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.RepositoryLocalServiceImpl 034 * @generated 035 */ 036 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 037 PortalException.class, SystemException.class}) 038 public interface RepositoryLocalService extends BaseLocalService, 039 PersistedModelLocalService { 040 /* 041 * NOTE FOR DEVELOPERS: 042 * 043 * 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. 044 */ 045 046 /** 047 * Adds the repository to the database. Also notifies the appropriate model listeners. 048 * 049 * @param repository the repository 050 * @return the repository that was added 051 * @throws SystemException if a system exception occurred 052 */ 053 public com.liferay.portal.model.Repository addRepository( 054 com.liferay.portal.model.Repository repository) 055 throws com.liferay.portal.kernel.exception.SystemException; 056 057 /** 058 * Creates a new repository with the primary key. Does not add the repository to the database. 059 * 060 * @param repositoryId the primary key for the new repository 061 * @return the new repository 062 */ 063 public com.liferay.portal.model.Repository createRepository( 064 long repositoryId); 065 066 /** 067 * Deletes the repository with the primary key from the database. Also notifies the appropriate model listeners. 068 * 069 * @param repositoryId the primary key of the repository 070 * @return the repository that was removed 071 * @throws PortalException if a repository with the primary key could not be found 072 * @throws SystemException if a system exception occurred 073 */ 074 public com.liferay.portal.model.Repository deleteRepository( 075 long repositoryId) 076 throws com.liferay.portal.kernel.exception.PortalException, 077 com.liferay.portal.kernel.exception.SystemException; 078 079 /** 080 * Deletes the repository from the database. Also notifies the appropriate model listeners. 081 * 082 * @param repository the repository 083 * @return the repository that was removed 084 * @throws SystemException if a system exception occurred 085 */ 086 public com.liferay.portal.model.Repository deleteRepository( 087 com.liferay.portal.model.Repository repository) 088 throws com.liferay.portal.kernel.exception.SystemException; 089 090 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 091 092 /** 093 * Performs a dynamic query on the database and returns the matching rows. 094 * 095 * @param dynamicQuery the dynamic query 096 * @return the matching rows 097 * @throws SystemException if a system exception occurred 098 */ 099 @SuppressWarnings("rawtypes") 100 public java.util.List dynamicQuery( 101 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 102 throws com.liferay.portal.kernel.exception.SystemException; 103 104 /** 105 * Performs a dynamic query on the database and returns a range of the matching rows. 106 * 107 * <p> 108 * 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. 109 * </p> 110 * 111 * @param dynamicQuery the dynamic query 112 * @param start the lower bound of the range of model instances 113 * @param end the upper bound of the range of model instances (not inclusive) 114 * @return the range of matching rows 115 * @throws SystemException if a system exception occurred 116 */ 117 @SuppressWarnings("rawtypes") 118 public java.util.List dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 120 int end) throws com.liferay.portal.kernel.exception.SystemException; 121 122 /** 123 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 124 * 125 * <p> 126 * 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. 127 * </p> 128 * 129 * @param dynamicQuery the dynamic query 130 * @param start the lower bound of the range of model instances 131 * @param end the upper bound of the range of model instances (not inclusive) 132 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 133 * @return the ordered range of matching rows 134 * @throws SystemException if a system exception occurred 135 */ 136 @SuppressWarnings("rawtypes") 137 public java.util.List dynamicQuery( 138 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 139 int end, 140 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 141 throws com.liferay.portal.kernel.exception.SystemException; 142 143 /** 144 * Returns the number of rows that match the dynamic query. 145 * 146 * @param dynamicQuery the dynamic query 147 * @return the number of rows that match the dynamic query 148 * @throws SystemException if a system exception occurred 149 */ 150 public long dynamicQueryCount( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 152 throws com.liferay.portal.kernel.exception.SystemException; 153 154 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 155 public com.liferay.portal.model.Repository fetchRepository( 156 long repositoryId) 157 throws com.liferay.portal.kernel.exception.SystemException; 158 159 /** 160 * Returns the repository with the primary key. 161 * 162 * @param repositoryId the primary key of the repository 163 * @return the repository 164 * @throws PortalException if a repository with the primary key could not be found 165 * @throws SystemException if a system exception occurred 166 */ 167 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 168 public com.liferay.portal.model.Repository getRepository(long repositoryId) 169 throws com.liferay.portal.kernel.exception.PortalException, 170 com.liferay.portal.kernel.exception.SystemException; 171 172 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 173 public com.liferay.portal.model.PersistedModel getPersistedModel( 174 java.io.Serializable primaryKeyObj) 175 throws com.liferay.portal.kernel.exception.PortalException, 176 com.liferay.portal.kernel.exception.SystemException; 177 178 /** 179 * Returns the repository with the UUID in the group. 180 * 181 * @param uuid the UUID of repository 182 * @param groupId the group id of the repository 183 * @return the repository 184 * @throws PortalException if a repository with the UUID in the group could not be found 185 * @throws SystemException if a system exception occurred 186 */ 187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 188 public com.liferay.portal.model.Repository getRepositoryByUuidAndGroupId( 189 java.lang.String uuid, long groupId) 190 throws com.liferay.portal.kernel.exception.PortalException, 191 com.liferay.portal.kernel.exception.SystemException; 192 193 /** 194 * Returns a range of all the repositories. 195 * 196 * <p> 197 * 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. 198 * </p> 199 * 200 * @param start the lower bound of the range of repositories 201 * @param end the upper bound of the range of repositories (not inclusive) 202 * @return the range of repositories 203 * @throws SystemException if a system exception occurred 204 */ 205 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 206 public java.util.List<com.liferay.portal.model.Repository> getRepositories( 207 int start, int end) 208 throws com.liferay.portal.kernel.exception.SystemException; 209 210 /** 211 * Returns the number of repositories. 212 * 213 * @return the number of repositories 214 * @throws SystemException if a system exception occurred 215 */ 216 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 217 public int getRepositoriesCount() 218 throws com.liferay.portal.kernel.exception.SystemException; 219 220 /** 221 * Updates the repository in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 222 * 223 * @param repository the repository 224 * @return the repository that was updated 225 * @throws SystemException if a system exception occurred 226 */ 227 public com.liferay.portal.model.Repository updateRepository( 228 com.liferay.portal.model.Repository repository) 229 throws com.liferay.portal.kernel.exception.SystemException; 230 231 /** 232 * Updates the repository in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 233 * 234 * @param repository the repository 235 * @param merge whether to merge the repository 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. 236 * @return the repository that was updated 237 * @throws SystemException if a system exception occurred 238 */ 239 public com.liferay.portal.model.Repository updateRepository( 240 com.liferay.portal.model.Repository repository, boolean merge) 241 throws com.liferay.portal.kernel.exception.SystemException; 242 243 /** 244 * Returns the Spring bean ID for this bean. 245 * 246 * @return the Spring bean ID for this bean 247 */ 248 public java.lang.String getBeanIdentifier(); 249 250 /** 251 * Sets the Spring bean ID for this bean. 252 * 253 * @param beanIdentifier the Spring bean ID for this bean 254 */ 255 public void setBeanIdentifier(java.lang.String beanIdentifier); 256 257 public long addRepository(long userId, long groupId, long classNameId, 258 long parentFolderId, java.lang.String name, 259 java.lang.String description, java.lang.String portletId, 260 com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties, 261 com.liferay.portal.service.ServiceContext serviceContext) 262 throws com.liferay.portal.kernel.exception.PortalException, 263 com.liferay.portal.kernel.exception.SystemException; 264 265 public void checkRepository(long repositoryId) 266 throws com.liferay.portal.kernel.exception.SystemException; 267 268 public void deleteRepositories(long groupId) 269 throws com.liferay.portal.kernel.exception.PortalException, 270 com.liferay.portal.kernel.exception.SystemException; 271 272 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 273 public com.liferay.portal.kernel.repository.LocalRepository getLocalRepositoryImpl( 274 long repositoryId) 275 throws com.liferay.portal.kernel.exception.PortalException, 276 com.liferay.portal.kernel.exception.SystemException; 277 278 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 279 public com.liferay.portal.kernel.repository.LocalRepository getLocalRepositoryImpl( 280 long folderId, long fileEntryId, long fileVersionId) 281 throws com.liferay.portal.kernel.exception.PortalException, 282 com.liferay.portal.kernel.exception.SystemException; 283 284 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 285 public com.liferay.portal.kernel.repository.Repository getRepositoryImpl( 286 long repositoryId) 287 throws com.liferay.portal.kernel.exception.PortalException, 288 com.liferay.portal.kernel.exception.SystemException; 289 290 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 291 public com.liferay.portal.kernel.repository.Repository getRepositoryImpl( 292 long folderId, long fileEntryId, long fileVersionId) 293 throws com.liferay.portal.kernel.exception.PortalException, 294 com.liferay.portal.kernel.exception.SystemException; 295 296 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 297 public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties( 298 long repositoryId) 299 throws com.liferay.portal.kernel.exception.PortalException, 300 com.liferay.portal.kernel.exception.SystemException; 301 302 public void updateRepository(long repositoryId, java.lang.String name, 303 java.lang.String description) 304 throws com.liferay.portal.kernel.exception.PortalException, 305 com.liferay.portal.kernel.exception.SystemException; 306 }