001 /** 002 * Copyright (c) 2000-2012 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.portlet.documentlibrary.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 import com.liferay.portal.service.BaseLocalService; 023 import com.liferay.portal.service.PersistedModelLocalService; 024 025 /** 026 * The interface for the d l sync local service. 027 * 028 * <p> 029 * 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. 030 * </p> 031 * 032 * @author Brian Wing Shun Chan 033 * @see DLSyncLocalServiceUtil 034 * @see com.liferay.portlet.documentlibrary.service.base.DLSyncLocalServiceBaseImpl 035 * @see com.liferay.portlet.documentlibrary.service.impl.DLSyncLocalServiceImpl 036 * @generated 037 */ 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface DLSyncLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link DLSyncLocalServiceUtil} to access the d l sync local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLSyncLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Adds the d l sync to the database. Also notifies the appropriate model listeners. 050 * 051 * @param dlSync the d l sync 052 * @return the d l sync that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portlet.documentlibrary.model.DLSync addDLSync( 056 com.liferay.portlet.documentlibrary.model.DLSync dlSync) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new d l sync with the primary key. Does not add the d l sync to the database. 061 * 062 * @param syncId the primary key for the new d l sync 063 * @return the new d l sync 064 */ 065 public com.liferay.portlet.documentlibrary.model.DLSync createDLSync( 066 long syncId); 067 068 /** 069 * Deletes the d l sync with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param syncId the primary key of the d l sync 072 * @return the d l sync that was removed 073 * @throws PortalException if a d l sync with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portlet.documentlibrary.model.DLSync deleteDLSync( 077 long syncId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the d l sync from the database. Also notifies the appropriate model listeners. 083 * 084 * @param dlSync the d l sync 085 * @return the d l sync that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portlet.documentlibrary.model.DLSync deleteDLSync( 089 com.liferay.portlet.documentlibrary.model.DLSync dlSync) 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.portlet.documentlibrary.model.impl.DLSyncModelImpl}. 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.portlet.documentlibrary.model.impl.DLSyncModelImpl}. 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 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 157 public com.liferay.portlet.documentlibrary.model.DLSync fetchDLSync( 158 long syncId) throws com.liferay.portal.kernel.exception.SystemException; 159 160 /** 161 * Returns the d l sync with the primary key. 162 * 163 * @param syncId the primary key of the d l sync 164 * @return the d l sync 165 * @throws PortalException if a d l sync with the primary key could not be found 166 * @throws SystemException if a system exception occurred 167 */ 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portlet.documentlibrary.model.DLSync getDLSync( 170 long syncId) 171 throws com.liferay.portal.kernel.exception.PortalException, 172 com.liferay.portal.kernel.exception.SystemException; 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public com.liferay.portal.model.PersistedModel getPersistedModel( 176 java.io.Serializable primaryKeyObj) 177 throws com.liferay.portal.kernel.exception.PortalException, 178 com.liferay.portal.kernel.exception.SystemException; 179 180 /** 181 * Returns a range of all the d l syncs. 182 * 183 * <p> 184 * 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.portlet.documentlibrary.model.impl.DLSyncModelImpl}. 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. 185 * </p> 186 * 187 * @param start the lower bound of the range of d l syncs 188 * @param end the upper bound of the range of d l syncs (not inclusive) 189 * @return the range of d l syncs 190 * @throws SystemException if a system exception occurred 191 */ 192 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 193 public java.util.List<com.liferay.portlet.documentlibrary.model.DLSync> getDLSyncs( 194 int start, int end) 195 throws com.liferay.portal.kernel.exception.SystemException; 196 197 /** 198 * Returns the number of d l syncs. 199 * 200 * @return the number of d l syncs 201 * @throws SystemException if a system exception occurred 202 */ 203 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 204 public int getDLSyncsCount() 205 throws com.liferay.portal.kernel.exception.SystemException; 206 207 /** 208 * Updates the d l sync in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 209 * 210 * @param dlSync the d l sync 211 * @return the d l sync that was updated 212 * @throws SystemException if a system exception occurred 213 */ 214 public com.liferay.portlet.documentlibrary.model.DLSync updateDLSync( 215 com.liferay.portlet.documentlibrary.model.DLSync dlSync) 216 throws com.liferay.portal.kernel.exception.SystemException; 217 218 /** 219 * Returns the Spring bean ID for this bean. 220 * 221 * @return the Spring bean ID for this bean 222 */ 223 public java.lang.String getBeanIdentifier(); 224 225 /** 226 * Sets the Spring bean ID for this bean. 227 * 228 * @param beanIdentifier the Spring bean ID for this bean 229 */ 230 public void setBeanIdentifier(java.lang.String beanIdentifier); 231 232 /** 233 * @deprecated {@link #addSync(long, String, long, long, long, String, 234 String, String, String)} 235 */ 236 public com.liferay.portlet.documentlibrary.model.DLSync addSync( 237 long fileId, java.lang.String fileUuid, long companyId, 238 long repositoryId, long parentFolderId, java.lang.String name, 239 java.lang.String type, java.lang.String version) 240 throws com.liferay.portal.kernel.exception.PortalException, 241 com.liferay.portal.kernel.exception.SystemException; 242 243 public com.liferay.portlet.documentlibrary.model.DLSync addSync( 244 long fileId, java.lang.String fileUuid, long companyId, 245 long repositoryId, long parentFolderId, java.lang.String name, 246 java.lang.String description, java.lang.String type, 247 java.lang.String version) 248 throws com.liferay.portal.kernel.exception.PortalException, 249 com.liferay.portal.kernel.exception.SystemException; 250 251 /** 252 * @deprecated {@link #updateSync(long, long, String, String, String, 253 String)} 254 */ 255 public com.liferay.portlet.documentlibrary.model.DLSync updateSync( 256 long fileId, long parentFolderId, java.lang.String name, 257 java.lang.String event, java.lang.String version) 258 throws com.liferay.portal.kernel.exception.PortalException, 259 com.liferay.portal.kernel.exception.SystemException; 260 261 public com.liferay.portlet.documentlibrary.model.DLSync updateSync( 262 long fileId, long parentFolderId, java.lang.String name, 263 java.lang.String description, java.lang.String event, 264 java.lang.String version) 265 throws com.liferay.portal.kernel.exception.PortalException, 266 com.liferay.portal.kernel.exception.SystemException; 267 }