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.portlet.wiki.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 import com.liferay.portal.service.BaseLocalService; 026 import com.liferay.portal.service.PersistedModelLocalService; 027 028 /** 029 * Provides the local service interface for WikiPageResource. Methods of this 030 * service will not have security checks based on the propagated JAAS 031 * credentials because this service can only be accessed from within the same 032 * VM. 033 * 034 * @author Brian Wing Shun Chan 035 * @see WikiPageResourceLocalServiceUtil 036 * @see com.liferay.portlet.wiki.service.base.WikiPageResourceLocalServiceBaseImpl 037 * @see com.liferay.portlet.wiki.service.impl.WikiPageResourceLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface WikiPageResourceLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link WikiPageResourceLocalServiceUtil} to access the wiki page resource local service. Add custom service methods to {@link com.liferay.portlet.wiki.service.impl.WikiPageResourceLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 public com.liferay.portlet.wiki.model.WikiPageResource addPageResource( 051 long nodeId, java.lang.String title); 052 053 /** 054 * Adds the wiki page resource to the database. Also notifies the appropriate model listeners. 055 * 056 * @param wikiPageResource the wiki page resource 057 * @return the wiki page resource that was added 058 */ 059 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 060 public com.liferay.portlet.wiki.model.WikiPageResource addWikiPageResource( 061 com.liferay.portlet.wiki.model.WikiPageResource wikiPageResource); 062 063 /** 064 * Creates a new wiki page resource with the primary key. Does not add the wiki page resource to the database. 065 * 066 * @param resourcePrimKey the primary key for the new wiki page resource 067 * @return the new wiki page resource 068 */ 069 public com.liferay.portlet.wiki.model.WikiPageResource createWikiPageResource( 070 long resourcePrimKey); 071 072 public void deletePageResource(long nodeId, java.lang.String title) 073 throws com.liferay.portal.kernel.exception.PortalException; 074 075 /** 076 * @throws PortalException 077 */ 078 @Override 079 public com.liferay.portal.model.PersistedModel deletePersistedModel( 080 com.liferay.portal.model.PersistedModel persistedModel) 081 throws com.liferay.portal.kernel.exception.PortalException; 082 083 /** 084 * Deletes the wiki page resource with the primary key from the database. Also notifies the appropriate model listeners. 085 * 086 * @param resourcePrimKey the primary key of the wiki page resource 087 * @return the wiki page resource that was removed 088 * @throws PortalException if a wiki page resource with the primary key could not be found 089 */ 090 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 091 public com.liferay.portlet.wiki.model.WikiPageResource deleteWikiPageResource( 092 long resourcePrimKey) 093 throws com.liferay.portal.kernel.exception.PortalException; 094 095 /** 096 * Deletes the wiki page resource from the database. Also notifies the appropriate model listeners. 097 * 098 * @param wikiPageResource the wiki page resource 099 * @return the wiki page resource that was removed 100 */ 101 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 102 public com.liferay.portlet.wiki.model.WikiPageResource deleteWikiPageResource( 103 com.liferay.portlet.wiki.model.WikiPageResource wikiPageResource); 104 105 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 106 107 /** 108 * Performs a dynamic query on the database and returns the matching rows. 109 * 110 * @param dynamicQuery the dynamic query 111 * @return the matching rows 112 */ 113 public <T> java.util.List<T> dynamicQuery( 114 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 115 116 /** 117 * Performs a dynamic query on the database and returns a range of the matching rows. 118 * 119 * <p> 120 * 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.wiki.model.impl.WikiPageResourceModelImpl}. 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. 121 * </p> 122 * 123 * @param dynamicQuery the dynamic query 124 * @param start the lower bound of the range of model instances 125 * @param end the upper bound of the range of model instances (not inclusive) 126 * @return the range of matching rows 127 */ 128 public <T> java.util.List<T> dynamicQuery( 129 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 130 int end); 131 132 /** 133 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 134 * 135 * <p> 136 * 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.wiki.model.impl.WikiPageResourceModelImpl}. 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. 137 * </p> 138 * 139 * @param dynamicQuery the dynamic query 140 * @param start the lower bound of the range of model instances 141 * @param end the upper bound of the range of model instances (not inclusive) 142 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 143 * @return the ordered range of matching rows 144 */ 145 public <T> java.util.List<T> dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 149 150 /** 151 * Returns the number of rows matching the dynamic query. 152 * 153 * @param dynamicQuery the dynamic query 154 * @return the number of rows matching the dynamic query 155 */ 156 public long dynamicQueryCount( 157 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 158 159 /** 160 * Returns the number of rows matching the dynamic query. 161 * 162 * @param dynamicQuery the dynamic query 163 * @param projection the projection to apply to the query 164 * @return the number of rows matching the dynamic query 165 */ 166 public long dynamicQueryCount( 167 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 168 com.liferay.portal.kernel.dao.orm.Projection projection); 169 170 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 171 public com.liferay.portlet.wiki.model.WikiPageResource fetchPageResource( 172 long nodeId, java.lang.String title); 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public com.liferay.portlet.wiki.model.WikiPageResource fetchPageResource( 176 java.lang.String uuid); 177 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public com.liferay.portlet.wiki.model.WikiPageResource fetchWikiPageResource( 180 long resourcePrimKey); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 184 185 /** 186 * Returns the Spring bean ID for this bean. 187 * 188 * @return the Spring bean ID for this bean 189 */ 190 public java.lang.String getBeanIdentifier(); 191 192 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 193 public com.liferay.portlet.wiki.model.WikiPageResource getPageResource( 194 long nodeId, java.lang.String title) 195 throws com.liferay.portal.kernel.exception.PortalException; 196 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portlet.wiki.model.WikiPageResource getPageResource( 199 long pageResourcePrimKey) 200 throws com.liferay.portal.kernel.exception.PortalException; 201 202 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 203 public long getPageResourcePrimKey(long nodeId, java.lang.String title); 204 205 @Override 206 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 207 public com.liferay.portal.model.PersistedModel getPersistedModel( 208 java.io.Serializable primaryKeyObj) 209 throws com.liferay.portal.kernel.exception.PortalException; 210 211 /** 212 * Returns the wiki page resource with the primary key. 213 * 214 * @param resourcePrimKey the primary key of the wiki page resource 215 * @return the wiki page resource 216 * @throws PortalException if a wiki page resource with the primary key could not be found 217 */ 218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 219 public com.liferay.portlet.wiki.model.WikiPageResource getWikiPageResource( 220 long resourcePrimKey) 221 throws com.liferay.portal.kernel.exception.PortalException; 222 223 /** 224 * Returns a range of all the wiki page resources. 225 * 226 * <p> 227 * 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.wiki.model.impl.WikiPageResourceModelImpl}. 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. 228 * </p> 229 * 230 * @param start the lower bound of the range of wiki page resources 231 * @param end the upper bound of the range of wiki page resources (not inclusive) 232 * @return the range of wiki page resources 233 */ 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public java.util.List<com.liferay.portlet.wiki.model.WikiPageResource> getWikiPageResources( 236 int start, int end); 237 238 /** 239 * Returns the number of wiki page resources. 240 * 241 * @return the number of wiki page resources 242 */ 243 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 244 public int getWikiPageResourcesCount(); 245 246 /** 247 * Sets the Spring bean ID for this bean. 248 * 249 * @param beanIdentifier the Spring bean ID for this bean 250 */ 251 public void setBeanIdentifier(java.lang.String beanIdentifier); 252 253 /** 254 * Updates the wiki page resource in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 255 * 256 * @param wikiPageResource the wiki page resource 257 * @return the wiki page resource that was updated 258 */ 259 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 260 public com.liferay.portlet.wiki.model.WikiPageResource updateWikiPageResource( 261 com.liferay.portlet.wiki.model.WikiPageResource wikiPageResource); 262 }