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