001 /** 002 * Copyright (c) 2000-present 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 RepositoryEntry. 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 RepositoryEntryLocalServiceUtil 034 * @see com.liferay.portal.service.base.RepositoryEntryLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.RepositoryEntryLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface RepositoryEntryLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * 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. 047 */ 048 049 /** 050 * Adds the repository entry to the database. Also notifies the appropriate model listeners. 051 * 052 * @param repositoryEntry the repository entry 053 * @return the repository entry that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.RepositoryEntry addRepositoryEntry( 057 com.liferay.portal.model.RepositoryEntry repositoryEntry); 058 059 public com.liferay.portal.model.RepositoryEntry addRepositoryEntry( 060 long userId, long groupId, long repositoryId, 061 java.lang.String mappedId, 062 com.liferay.portal.service.ServiceContext serviceContext) 063 throws PortalException; 064 065 /** 066 * Creates a new repository entry with the primary key. Does not add the repository entry to the database. 067 * 068 * @param repositoryEntryId the primary key for the new repository entry 069 * @return the new repository entry 070 */ 071 public com.liferay.portal.model.RepositoryEntry createRepositoryEntry( 072 long repositoryEntryId); 073 074 /** 075 * @throws PortalException 076 */ 077 @Override 078 public com.liferay.portal.model.PersistedModel deletePersistedModel( 079 com.liferay.portal.model.PersistedModel persistedModel) 080 throws PortalException; 081 082 public void deleteRepositoryEntries(long repositoryId, 083 java.lang.Iterable<java.lang.String> mappedIds) 084 throws PortalException; 085 086 /** 087 * Deletes the repository entry from the database. Also notifies the appropriate model listeners. 088 * 089 * @param repositoryEntry the repository entry 090 * @return the repository entry that was removed 091 */ 092 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 093 public com.liferay.portal.model.RepositoryEntry deleteRepositoryEntry( 094 com.liferay.portal.model.RepositoryEntry repositoryEntry); 095 096 /** 097 * Deletes the repository entry with the primary key from the database. Also notifies the appropriate model listeners. 098 * 099 * @param repositoryEntryId the primary key of the repository entry 100 * @return the repository entry that was removed 101 * @throws PortalException if a repository entry with the primary key could not be found 102 */ 103 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 104 public com.liferay.portal.model.RepositoryEntry deleteRepositoryEntry( 105 long repositoryEntryId) throws PortalException; 106 107 public void deleteRepositoryEntry(long repositoryId, 108 java.lang.String mappedId) throws PortalException; 109 110 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 111 112 /** 113 * Performs a dynamic query on the database and returns the matching rows. 114 * 115 * @param dynamicQuery the dynamic query 116 * @return the matching rows 117 */ 118 public <T> java.util.List<T> dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 120 121 /** 122 * Performs a dynamic query on the database and returns a range of the matching rows. 123 * 124 * <p> 125 * 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. 126 * </p> 127 * 128 * @param dynamicQuery the dynamic query 129 * @param start the lower bound of the range of model instances 130 * @param end the upper bound of the range of model instances (not inclusive) 131 * @return the range of matching rows 132 */ 133 public <T> java.util.List<T> dynamicQuery( 134 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 135 int end); 136 137 /** 138 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 139 * 140 * <p> 141 * 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. 142 * </p> 143 * 144 * @param dynamicQuery the dynamic query 145 * @param start the lower bound of the range of model instances 146 * @param end the upper bound of the range of model instances (not inclusive) 147 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 148 * @return the ordered range of matching rows 149 */ 150 public <T> java.util.List<T> dynamicQuery( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 152 int end, 153 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 154 155 /** 156 * Returns the number of rows matching the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @return the number of rows matching the dynamic query 160 */ 161 public long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 163 164 /** 165 * Returns the number of rows matching the dynamic query. 166 * 167 * @param dynamicQuery the dynamic query 168 * @param projection the projection to apply to the query 169 * @return the number of rows matching the dynamic query 170 */ 171 public long dynamicQueryCount( 172 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 173 com.liferay.portal.kernel.dao.orm.Projection projection); 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.model.RepositoryEntry fetchRepositoryEntry( 177 long repositoryEntryId); 178 179 /** 180 * Returns the repository entry matching the UUID and group. 181 * 182 * @param uuid the repository entry's UUID 183 * @param groupId the primary key of the group 184 * @return the matching repository entry, or <code>null</code> if a matching repository entry could not be found 185 */ 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portal.model.RepositoryEntry fetchRepositoryEntryByUuidAndGroupId( 188 java.lang.String uuid, long groupId); 189 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 192 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 195 com.liferay.portlet.exportimport.lar.PortletDataContext portletDataContext); 196 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 199 200 /** 201 * Returns the OSGi service identifier. 202 * 203 * @return the OSGi service identifier 204 */ 205 public java.lang.String getOSGiServiceIdentifier(); 206 207 @Override 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public com.liferay.portal.model.PersistedModel getPersistedModel( 210 java.io.Serializable primaryKeyObj) throws PortalException; 211 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntries( 214 long repositoryId); 215 216 /** 217 * Returns a range of all the repository entries. 218 * 219 * <p> 220 * 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. 221 * </p> 222 * 223 * @param start the lower bound of the range of repository entries 224 * @param end the upper bound of the range of repository entries (not inclusive) 225 * @return the range of repository entries 226 */ 227 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 228 public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntries( 229 int start, int end); 230 231 /** 232 * Returns all the repository entries matching the UUID and company. 233 * 234 * @param uuid the UUID of the repository entries 235 * @param companyId the primary key of the company 236 * @return the matching repository entries, or an empty list if no matches were found 237 */ 238 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 239 public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntriesByUuidAndCompanyId( 240 java.lang.String uuid, long companyId); 241 242 /** 243 * Returns a range of repository entries matching the UUID and company. 244 * 245 * @param uuid the UUID of the repository entries 246 * @param companyId the primary key of the company 247 * @param start the lower bound of the range of repository entries 248 * @param end the upper bound of the range of repository entries (not inclusive) 249 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 250 * @return the range of matching repository entries, or an empty list if no matches were found 251 */ 252 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 253 public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntriesByUuidAndCompanyId( 254 java.lang.String uuid, long companyId, int start, int end, 255 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.RepositoryEntry> orderByComparator); 256 257 /** 258 * Returns the number of repository entries. 259 * 260 * @return the number of repository entries 261 */ 262 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 263 public int getRepositoryEntriesCount(); 264 265 /** 266 * Returns the repository entry with the primary key. 267 * 268 * @param repositoryEntryId the primary key of the repository entry 269 * @return the repository entry 270 * @throws PortalException if a repository entry with the primary key could not be found 271 */ 272 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 273 public com.liferay.portal.model.RepositoryEntry getRepositoryEntry( 274 long repositoryEntryId) throws PortalException; 275 276 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 277 public com.liferay.portal.model.RepositoryEntry getRepositoryEntry( 278 long userId, long groupId, long repositoryId, java.lang.String objectId) 279 throws PortalException; 280 281 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 282 public com.liferay.portal.model.RepositoryEntry getRepositoryEntry( 283 java.lang.String uuid, long groupId) throws PortalException; 284 285 /** 286 * Returns the repository entry matching the UUID and group. 287 * 288 * @param uuid the repository entry's UUID 289 * @param groupId the primary key of the group 290 * @return the matching repository entry 291 * @throws PortalException if a matching repository entry could not be found 292 */ 293 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 294 public com.liferay.portal.model.RepositoryEntry getRepositoryEntryByUuidAndGroupId( 295 java.lang.String uuid, long groupId) throws PortalException; 296 297 /** 298 * Updates the repository entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 299 * 300 * @param repositoryEntry the repository entry 301 * @return the repository entry that was updated 302 */ 303 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 304 public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry( 305 com.liferay.portal.model.RepositoryEntry repositoryEntry); 306 307 public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry( 308 long repositoryEntryId, java.lang.String mappedId) 309 throws PortalException; 310 }