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 entry 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 RepositoryEntryLocalServiceUtil 032 * @see com.liferay.portal.service.base.RepositoryEntryLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.RepositoryEntryLocalServiceImpl 034 * @generated 035 */ 036 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 037 PortalException.class, SystemException.class}) 038 public interface RepositoryEntryLocalService extends BaseLocalService, 039 PersistedModelLocalService { 040 /* 041 * NOTE FOR DEVELOPERS: 042 * 043 * 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. 044 */ 045 046 /** 047 * Adds the repository entry to the database. Also notifies the appropriate model listeners. 048 * 049 * @param repositoryEntry the repository entry 050 * @return the repository entry that was added 051 * @throws SystemException if a system exception occurred 052 */ 053 public com.liferay.portal.model.RepositoryEntry addRepositoryEntry( 054 com.liferay.portal.model.RepositoryEntry repositoryEntry) 055 throws com.liferay.portal.kernel.exception.SystemException; 056 057 /** 058 * Creates a new repository entry with the primary key. Does not add the repository entry to the database. 059 * 060 * @param repositoryEntryId the primary key for the new repository entry 061 * @return the new repository entry 062 */ 063 public com.liferay.portal.model.RepositoryEntry createRepositoryEntry( 064 long repositoryEntryId); 065 066 /** 067 * Deletes the repository entry with the primary key from the database. Also notifies the appropriate model listeners. 068 * 069 * @param repositoryEntryId the primary key of the repository entry 070 * @return the repository entry that was removed 071 * @throws PortalException if a repository entry with the primary key could not be found 072 * @throws SystemException if a system exception occurred 073 */ 074 public com.liferay.portal.model.RepositoryEntry deleteRepositoryEntry( 075 long repositoryEntryId) 076 throws com.liferay.portal.kernel.exception.PortalException, 077 com.liferay.portal.kernel.exception.SystemException; 078 079 /** 080 * Deletes the repository entry from the database. Also notifies the appropriate model listeners. 081 * 082 * @param repositoryEntry the repository entry 083 * @return the repository entry that was removed 084 * @throws SystemException if a system exception occurred 085 */ 086 public com.liferay.portal.model.RepositoryEntry deleteRepositoryEntry( 087 com.liferay.portal.model.RepositoryEntry repositoryEntry) 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.RepositoryEntry fetchRepositoryEntry( 156 long repositoryEntryId) 157 throws com.liferay.portal.kernel.exception.SystemException; 158 159 /** 160 * Returns the repository entry with the primary key. 161 * 162 * @param repositoryEntryId the primary key of the repository entry 163 * @return the repository entry 164 * @throws PortalException if a repository entry 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.RepositoryEntry getRepositoryEntry( 169 long repositoryEntryId) 170 throws com.liferay.portal.kernel.exception.PortalException, 171 com.liferay.portal.kernel.exception.SystemException; 172 173 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 174 public com.liferay.portal.model.PersistedModel getPersistedModel( 175 java.io.Serializable primaryKeyObj) 176 throws com.liferay.portal.kernel.exception.PortalException, 177 com.liferay.portal.kernel.exception.SystemException; 178 179 /** 180 * Returns the repository entry with the UUID in the group. 181 * 182 * @param uuid the UUID of repository entry 183 * @param groupId the group id of the repository entry 184 * @return the repository entry 185 * @throws PortalException if a repository entry with the UUID in the group could not be found 186 * @throws SystemException if a system exception occurred 187 */ 188 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 189 public com.liferay.portal.model.RepositoryEntry getRepositoryEntryByUuidAndGroupId( 190 java.lang.String uuid, long groupId) 191 throws com.liferay.portal.kernel.exception.PortalException, 192 com.liferay.portal.kernel.exception.SystemException; 193 194 /** 195 * Returns a range of all the repository entries. 196 * 197 * <p> 198 * 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. 199 * </p> 200 * 201 * @param start the lower bound of the range of repository entries 202 * @param end the upper bound of the range of repository entries (not inclusive) 203 * @return the range of repository entries 204 * @throws SystemException if a system exception occurred 205 */ 206 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 207 public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntries( 208 int start, int end) 209 throws com.liferay.portal.kernel.exception.SystemException; 210 211 /** 212 * Returns the number of repository entries. 213 * 214 * @return the number of repository entries 215 * @throws SystemException if a system exception occurred 216 */ 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public int getRepositoryEntriesCount() 219 throws com.liferay.portal.kernel.exception.SystemException; 220 221 /** 222 * Updates the repository entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 223 * 224 * @param repositoryEntry the repository entry 225 * @return the repository entry that was updated 226 * @throws SystemException if a system exception occurred 227 */ 228 public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry( 229 com.liferay.portal.model.RepositoryEntry repositoryEntry) 230 throws com.liferay.portal.kernel.exception.SystemException; 231 232 /** 233 * Updates the repository entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 234 * 235 * @param repositoryEntry the repository entry 236 * @param merge whether to merge the repository entry 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. 237 * @return the repository entry that was updated 238 * @throws SystemException if a system exception occurred 239 */ 240 public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry( 241 com.liferay.portal.model.RepositoryEntry repositoryEntry, boolean merge) 242 throws com.liferay.portal.kernel.exception.SystemException; 243 244 /** 245 * Returns the Spring bean ID for this bean. 246 * 247 * @return the Spring bean ID for this bean 248 */ 249 public java.lang.String getBeanIdentifier(); 250 251 /** 252 * Sets the Spring bean ID for this bean. 253 * 254 * @param beanIdentifier the Spring bean ID for this bean 255 */ 256 public void setBeanIdentifier(java.lang.String beanIdentifier); 257 258 public com.liferay.portal.model.RepositoryEntry addRepositoryEntry( 259 long groupId, long repositoryId, java.lang.String mappedId, 260 com.liferay.portal.service.ServiceContext serviceContext) 261 throws com.liferay.portal.kernel.exception.SystemException; 262 263 public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry( 264 long repositoryEntryId, java.lang.String mappedId) 265 throws com.liferay.portal.kernel.exception.PortalException, 266 com.liferay.portal.kernel.exception.SystemException; 267 }