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 WebDAVProps. 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 WebDAVPropsLocalServiceUtil 034 * @see com.liferay.portal.service.base.WebDAVPropsLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.WebDAVPropsLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface WebDAVPropsLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link WebDAVPropsLocalServiceUtil} to access the web d a v props local service. Add custom service methods to {@link com.liferay.portal.service.impl.WebDAVPropsLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the web d a v props to the database. Also notifies the appropriate model listeners. 051 * 052 * @param webDAVProps the web d a v props 053 * @return the web d a v props that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.WebDAVProps addWebDAVProps( 057 com.liferay.portal.model.WebDAVProps webDAVProps); 058 059 /** 060 * Creates a new web d a v props with the primary key. Does not add the web d a v props to the database. 061 * 062 * @param webDavPropsId the primary key for the new web d a v props 063 * @return the new web d a v props 064 */ 065 public com.liferay.portal.model.WebDAVProps createWebDAVProps( 066 long webDavPropsId); 067 068 /** 069 * @throws PortalException 070 */ 071 @Override 072 public com.liferay.portal.model.PersistedModel deletePersistedModel( 073 com.liferay.portal.model.PersistedModel persistedModel) 074 throws PortalException; 075 076 public void deleteWebDAVProps(java.lang.String className, long classPK); 077 078 /** 079 * Deletes the web d a v props from the database. Also notifies the appropriate model listeners. 080 * 081 * @param webDAVProps the web d a v props 082 * @return the web d a v props that was removed 083 */ 084 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 085 public com.liferay.portal.model.WebDAVProps deleteWebDAVProps( 086 com.liferay.portal.model.WebDAVProps webDAVProps); 087 088 /** 089 * Deletes the web d a v props with the primary key from the database. Also notifies the appropriate model listeners. 090 * 091 * @param webDavPropsId the primary key of the web d a v props 092 * @return the web d a v props that was removed 093 * @throws PortalException if a web d a v props with the primary key could not be found 094 */ 095 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 096 public com.liferay.portal.model.WebDAVProps deleteWebDAVProps( 097 long webDavPropsId) throws PortalException; 098 099 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 100 101 /** 102 * Performs a dynamic query on the database and returns the matching rows. 103 * 104 * @param dynamicQuery the dynamic query 105 * @return the matching rows 106 */ 107 public <T> java.util.List<T> dynamicQuery( 108 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * 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.WebDAVPropsModelImpl}. 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. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 */ 122 public <T> java.util.List<T> dynamicQuery( 123 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 124 int end); 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * 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.WebDAVPropsModelImpl}. 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 */ 139 public <T> java.util.List<T> dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 143 144 /** 145 * Returns the number of rows matching the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query 148 * @return the number of rows matching the dynamic query 149 */ 150 public long dynamicQueryCount( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 152 153 /** 154 * Returns the number of rows matching the dynamic query. 155 * 156 * @param dynamicQuery the dynamic query 157 * @param projection the projection to apply to the query 158 * @return the number of rows matching the dynamic query 159 */ 160 public long dynamicQueryCount( 161 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 162 com.liferay.portal.kernel.dao.orm.Projection projection); 163 164 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 165 public com.liferay.portal.model.WebDAVProps fetchWebDAVProps( 166 long webDavPropsId); 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 173 174 /** 175 * Returns the OSGi service identifier. 176 * 177 * @return the OSGi service identifier 178 */ 179 public java.lang.String getOSGiServiceIdentifier(); 180 181 @Override 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.model.PersistedModel getPersistedModel( 184 java.io.Serializable primaryKeyObj) throws PortalException; 185 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portal.model.WebDAVProps getWebDAVProps(long companyId, 188 java.lang.String className, long classPK); 189 190 /** 191 * Returns the web d a v props with the primary key. 192 * 193 * @param webDavPropsId the primary key of the web d a v props 194 * @return the web d a v props 195 * @throws PortalException if a web d a v props with the primary key could not be found 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portal.model.WebDAVProps getWebDAVProps( 199 long webDavPropsId) throws PortalException; 200 201 /** 202 * Returns a range of all the web d a v propses. 203 * 204 * <p> 205 * 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.WebDAVPropsModelImpl}. 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. 206 * </p> 207 * 208 * @param start the lower bound of the range of web d a v propses 209 * @param end the upper bound of the range of web d a v propses (not inclusive) 210 * @return the range of web d a v propses 211 */ 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public java.util.List<com.liferay.portal.model.WebDAVProps> getWebDAVPropses( 214 int start, int end); 215 216 /** 217 * Returns the number of web d a v propses. 218 * 219 * @return the number of web d a v propses 220 */ 221 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 222 public int getWebDAVPropsesCount(); 223 224 public void storeWebDAVProps( 225 com.liferay.portal.model.WebDAVProps webDavProps) 226 throws PortalException; 227 228 /** 229 * Updates the web d a v props in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 230 * 231 * @param webDAVProps the web d a v props 232 * @return the web d a v props that was updated 233 */ 234 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 235 public com.liferay.portal.model.WebDAVProps updateWebDAVProps( 236 com.liferay.portal.model.WebDAVProps webDAVProps); 237 }