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 RepositoryEntry. 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 RepositoryEntryLocalServiceUtil 033 * @see com.liferay.portal.service.base.RepositoryEntryLocalServiceBaseImpl 034 * @see com.liferay.portal.service.impl.RepositoryEntryLocalServiceImpl 035 * @generated 036 */ 037 @ProviderType 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface RepositoryEntryLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link RepositoryEntryLocalServiceUtil} to access the repository entry local service. Add custom service methods to {@link com.liferay.portal.service.impl.RepositoryEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Adds the repository entry to the database. Also notifies the appropriate model listeners. 050 * 051 * @param repositoryEntry the repository entry 052 * @return the repository entry that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portal.model.RepositoryEntry addRepositoryEntry( 056 com.liferay.portal.model.RepositoryEntry repositoryEntry) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new repository entry with the primary key. Does not add the repository entry to the database. 061 * 062 * @param repositoryEntryId the primary key for the new repository entry 063 * @return the new repository entry 064 */ 065 public com.liferay.portal.model.RepositoryEntry createRepositoryEntry( 066 long repositoryEntryId); 067 068 /** 069 * Deletes the repository entry with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param repositoryEntryId the primary key of the repository entry 072 * @return the repository entry that was removed 073 * @throws PortalException if a repository entry with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portal.model.RepositoryEntry deleteRepositoryEntry( 077 long repositoryEntryId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the repository entry from the database. Also notifies the appropriate model listeners. 083 * 084 * @param repositoryEntry the repository entry 085 * @return the repository entry that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portal.model.RepositoryEntry deleteRepositoryEntry( 089 com.liferay.portal.model.RepositoryEntry repositoryEntry) 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.RepositoryEntryModelImpl}. 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.RepositoryEntryModelImpl}. 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.RepositoryEntry fetchRepositoryEntry( 171 long repositoryEntryId) 172 throws com.liferay.portal.kernel.exception.SystemException; 173 174 /** 175 * Returns the repository entry with the matching UUID and company. 176 * 177 * @param uuid the repository entry's UUID 178 * @param companyId the primary key of the company 179 * @return the matching repository entry, or <code>null</code> if a matching repository entry 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.RepositoryEntry fetchRepositoryEntryByUuidAndCompanyId( 184 java.lang.String uuid, long companyId) 185 throws com.liferay.portal.kernel.exception.SystemException; 186 187 /** 188 * Returns the repository entry matching the UUID and group. 189 * 190 * @param uuid the repository entry's UUID 191 * @param groupId the primary key of the group 192 * @return the matching repository entry, or <code>null</code> if a matching repository entry 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.RepositoryEntry fetchRepositoryEntryByUuidAndGroupId( 197 java.lang.String uuid, long groupId) 198 throws com.liferay.portal.kernel.exception.SystemException; 199 200 /** 201 * Returns the repository entry with the primary key. 202 * 203 * @param repositoryEntryId the primary key of the repository entry 204 * @return the repository entry 205 * @throws PortalException if a repository entry 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.RepositoryEntry getRepositoryEntry( 210 long repositoryEntryId) 211 throws com.liferay.portal.kernel.exception.PortalException, 212 com.liferay.portal.kernel.exception.SystemException; 213 214 @Override 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public com.liferay.portal.model.PersistedModel getPersistedModel( 217 java.io.Serializable primaryKeyObj) 218 throws com.liferay.portal.kernel.exception.PortalException, 219 com.liferay.portal.kernel.exception.SystemException; 220 221 /** 222 * Returns the repository entry with the matching UUID and company. 223 * 224 * @param uuid the repository entry's UUID 225 * @param companyId the primary key of the company 226 * @return the matching repository entry 227 * @throws PortalException if a matching repository entry could not be found 228 * @throws SystemException if a system exception occurred 229 */ 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public com.liferay.portal.model.RepositoryEntry getRepositoryEntryByUuidAndCompanyId( 232 java.lang.String uuid, long companyId) 233 throws com.liferay.portal.kernel.exception.PortalException, 234 com.liferay.portal.kernel.exception.SystemException; 235 236 /** 237 * Returns the repository entry matching the UUID and group. 238 * 239 * @param uuid the repository entry's UUID 240 * @param groupId the primary key of the group 241 * @return the matching repository entry 242 * @throws PortalException if a matching repository entry could not be found 243 * @throws SystemException if a system exception occurred 244 */ 245 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 246 public com.liferay.portal.model.RepositoryEntry getRepositoryEntryByUuidAndGroupId( 247 java.lang.String uuid, long groupId) 248 throws com.liferay.portal.kernel.exception.PortalException, 249 com.liferay.portal.kernel.exception.SystemException; 250 251 /** 252 * Returns a range of all the repository entries. 253 * 254 * <p> 255 * 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.RepositoryEntryModelImpl}. 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. 256 * </p> 257 * 258 * @param start the lower bound of the range of repository entries 259 * @param end the upper bound of the range of repository entries (not inclusive) 260 * @return the range of repository entries 261 * @throws SystemException if a system exception occurred 262 */ 263 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 264 public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntries( 265 int start, int end) 266 throws com.liferay.portal.kernel.exception.SystemException; 267 268 /** 269 * Returns the number of repository entries. 270 * 271 * @return the number of repository entries 272 * @throws SystemException if a system exception occurred 273 */ 274 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 275 public int getRepositoryEntriesCount() 276 throws com.liferay.portal.kernel.exception.SystemException; 277 278 /** 279 * Updates the repository entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 280 * 281 * @param repositoryEntry the repository entry 282 * @return the repository entry that was updated 283 * @throws SystemException if a system exception occurred 284 */ 285 public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry( 286 com.liferay.portal.model.RepositoryEntry repositoryEntry) 287 throws com.liferay.portal.kernel.exception.SystemException; 288 289 /** 290 * Returns the Spring bean ID for this bean. 291 * 292 * @return the Spring bean ID for this bean 293 */ 294 public java.lang.String getBeanIdentifier(); 295 296 /** 297 * Sets the Spring bean ID for this bean. 298 * 299 * @param beanIdentifier the Spring bean ID for this bean 300 */ 301 public void setBeanIdentifier(java.lang.String beanIdentifier); 302 303 public com.liferay.portal.model.RepositoryEntry addRepositoryEntry( 304 long userId, long groupId, long repositoryId, 305 java.lang.String mappedId, 306 com.liferay.portal.service.ServiceContext serviceContext) 307 throws com.liferay.portal.kernel.exception.PortalException, 308 com.liferay.portal.kernel.exception.SystemException; 309 310 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 311 public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntries( 312 long repositoryId) 313 throws com.liferay.portal.kernel.exception.SystemException; 314 315 public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry( 316 long repositoryEntryId, java.lang.String mappedId) 317 throws com.liferay.portal.kernel.exception.PortalException, 318 com.liferay.portal.kernel.exception.SystemException; 319 }