001 /** 002 * Copyright (c) 2000-2010 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.annotation.Isolation; 018 import com.liferay.portal.kernel.annotation.Propagation; 019 import com.liferay.portal.kernel.annotation.Transactional; 020 import com.liferay.portal.kernel.exception.PortalException; 021 import com.liferay.portal.kernel.exception.SystemException; 022 023 /** 024 * The interface for the portlet preferences local service. 025 * 026 * <p> 027 * Never modify or reference this interface directly. Always use {@link PortletPreferencesLocalServiceUtil} to access the portlet preferences local service. Add custom service methods to {@link com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 028 * </p> 029 * 030 * <p> 031 * 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. 032 * </p> 033 * 034 * @author Brian Wing Shun Chan 035 * @see PortletPreferencesLocalServiceUtil 036 * @see com.liferay.portal.service.base.PortletPreferencesLocalServiceBaseImpl 037 * @see com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl 038 * @generated 039 */ 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface PortletPreferencesLocalService { 043 /** 044 * Adds the portlet preferences to the database. Also notifies the appropriate model listeners. 045 * 046 * @param portletPreferences the portlet preferences to add 047 * @return the portlet preferences that was added 048 * @throws SystemException if a system exception occurred 049 */ 050 public com.liferay.portal.model.PortletPreferences addPortletPreferences( 051 com.liferay.portal.model.PortletPreferences portletPreferences) 052 throws com.liferay.portal.kernel.exception.SystemException; 053 054 /** 055 * Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database. 056 * 057 * @param portletPreferencesId the primary key for the new portlet preferences 058 * @return the new portlet preferences 059 */ 060 public com.liferay.portal.model.PortletPreferences createPortletPreferences( 061 long portletPreferencesId); 062 063 /** 064 * Deletes the portlet preferences with the primary key from the database. Also notifies the appropriate model listeners. 065 * 066 * @param portletPreferencesId the primary key of the portlet preferences to delete 067 * @throws PortalException if a portlet preferences with the primary key could not be found 068 * @throws SystemException if a system exception occurred 069 */ 070 public void deletePortletPreferences(long portletPreferencesId) 071 throws com.liferay.portal.kernel.exception.PortalException, 072 com.liferay.portal.kernel.exception.SystemException; 073 074 /** 075 * Deletes the portlet preferences from the database. Also notifies the appropriate model listeners. 076 * 077 * @param portletPreferences the portlet preferences to delete 078 * @throws SystemException if a system exception occurred 079 */ 080 public void deletePortletPreferences( 081 com.liferay.portal.model.PortletPreferences portletPreferences) 082 throws com.liferay.portal.kernel.exception.SystemException; 083 084 /** 085 * Performs a dynamic query on the database and returns the matching rows. 086 * 087 * @param dynamicQuery the dynamic query to search with 088 * @return the matching rows 089 * @throws SystemException if a system exception occurred 090 */ 091 @SuppressWarnings("rawtypes") 092 public java.util.List dynamicQuery( 093 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 094 throws com.liferay.portal.kernel.exception.SystemException; 095 096 /** 097 * Performs a dynamic query on the database and returns a range of the matching rows. 098 * 099 * <p> 100 * 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. 101 * </p> 102 * 103 * @param dynamicQuery the dynamic query to search with 104 * @param start the lower bound of the range of model instances to return 105 * @param end the upper bound of the range of model instances to return (not inclusive) 106 * @return the range of matching rows 107 * @throws SystemException if a system exception occurred 108 */ 109 @SuppressWarnings("rawtypes") 110 public java.util.List dynamicQuery( 111 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 112 int end) throws com.liferay.portal.kernel.exception.SystemException; 113 114 /** 115 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 116 * 117 * <p> 118 * 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. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query to search with 122 * @param start the lower bound of the range of model instances to return 123 * @param end the upper bound of the range of model instances to return (not inclusive) 124 * @param orderByComparator the comparator to order the results by 125 * @return the ordered range of matching rows 126 * @throws SystemException if a system exception occurred 127 */ 128 @SuppressWarnings("rawtypes") 129 public java.util.List dynamicQuery( 130 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 131 int end, 132 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 133 throws com.liferay.portal.kernel.exception.SystemException; 134 135 /** 136 * Counts the number of rows that match the dynamic query. 137 * 138 * @param dynamicQuery the dynamic query to search with 139 * @return the number of rows that match the dynamic query 140 * @throws SystemException if a system exception occurred 141 */ 142 public long dynamicQueryCount( 143 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 144 throws com.liferay.portal.kernel.exception.SystemException; 145 146 /** 147 * Gets the portlet preferences with the primary key. 148 * 149 * @param portletPreferencesId the primary key of the portlet preferences to get 150 * @return the portlet preferences 151 * @throws PortalException if a portlet preferences with the primary key could not be found 152 * @throws SystemException if a system exception occurred 153 */ 154 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 155 public com.liferay.portal.model.PortletPreferences getPortletPreferences( 156 long portletPreferencesId) 157 throws com.liferay.portal.kernel.exception.PortalException, 158 com.liferay.portal.kernel.exception.SystemException; 159 160 /** 161 * Gets a range of all the portlet preferenceses. 162 * 163 * <p> 164 * 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. 165 * </p> 166 * 167 * @param start the lower bound of the range of portlet preferenceses to return 168 * @param end the upper bound of the range of portlet preferenceses to return (not inclusive) 169 * @return the range of portlet preferenceses 170 * @throws SystemException if a system exception occurred 171 */ 172 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 173 public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferenceses( 174 int start, int end) 175 throws com.liferay.portal.kernel.exception.SystemException; 176 177 /** 178 * Gets the number of portlet preferenceses. 179 * 180 * @return the number of portlet preferenceses 181 * @throws SystemException if a system exception occurred 182 */ 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public int getPortletPreferencesesCount() 185 throws com.liferay.portal.kernel.exception.SystemException; 186 187 /** 188 * Updates the portlet preferences in the database. Also notifies the appropriate model listeners. 189 * 190 * @param portletPreferences the portlet preferences to update 191 * @return the portlet preferences that was updated 192 * @throws SystemException if a system exception occurred 193 */ 194 public com.liferay.portal.model.PortletPreferences updatePortletPreferences( 195 com.liferay.portal.model.PortletPreferences portletPreferences) 196 throws com.liferay.portal.kernel.exception.SystemException; 197 198 /** 199 * Updates the portlet preferences in the database. Also notifies the appropriate model listeners. 200 * 201 * @param portletPreferences the portlet preferences to update 202 * @param merge whether to merge the portlet preferences 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. 203 * @return the portlet preferences that was updated 204 * @throws SystemException if a system exception occurred 205 */ 206 public com.liferay.portal.model.PortletPreferences updatePortletPreferences( 207 com.liferay.portal.model.PortletPreferences portletPreferences, 208 boolean merge) 209 throws com.liferay.portal.kernel.exception.SystemException; 210 211 public com.liferay.portal.model.PortletPreferences addPortletPreferences( 212 long companyId, long ownerId, int ownerType, long plid, 213 java.lang.String portletId, com.liferay.portal.model.Portlet portlet, 214 java.lang.String defaultPreferences) 215 throws com.liferay.portal.kernel.exception.SystemException; 216 217 public void deletePortletPreferences(long ownerId, int ownerType, long plid) 218 throws com.liferay.portal.kernel.exception.SystemException; 219 220 public void deletePortletPreferences(long ownerId, int ownerType, 221 long plid, java.lang.String portletId) 222 throws com.liferay.portal.kernel.exception.PortalException, 223 com.liferay.portal.kernel.exception.SystemException; 224 225 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 226 public javax.portlet.PortletPreferences getDefaultPreferences( 227 long companyId, java.lang.String portletId) 228 throws com.liferay.portal.kernel.exception.SystemException; 229 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences() 232 throws com.liferay.portal.kernel.exception.SystemException; 233 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences( 236 long plid, java.lang.String portletId) 237 throws com.liferay.portal.kernel.exception.SystemException; 238 239 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 240 public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences( 241 long ownerId, int ownerType, long plid) 242 throws com.liferay.portal.kernel.exception.SystemException; 243 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public com.liferay.portal.model.PortletPreferences getPortletPreferences( 246 long ownerId, int ownerType, long plid, java.lang.String portletId) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException; 249 250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 251 public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferencesByPlid( 252 long plid) throws com.liferay.portal.kernel.exception.SystemException; 253 254 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 255 public javax.portlet.PortletPreferences getPreferences( 256 com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds) 257 throws com.liferay.portal.kernel.exception.SystemException; 258 259 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 260 public javax.portlet.PortletPreferences getPreferences(long companyId, 261 long ownerId, int ownerType, long plid, java.lang.String portletId) 262 throws com.liferay.portal.kernel.exception.SystemException; 263 264 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 265 public javax.portlet.PortletPreferences getPreferences(long companyId, 266 long ownerId, int ownerType, long plid, java.lang.String portletId, 267 java.lang.String defaultPreferences) 268 throws com.liferay.portal.kernel.exception.SystemException; 269 270 public com.liferay.portal.model.PortletPreferences updatePreferences( 271 long ownerId, int ownerType, long plid, java.lang.String portletId, 272 javax.portlet.PortletPreferences preferences) 273 throws com.liferay.portal.kernel.exception.SystemException; 274 275 public com.liferay.portal.model.PortletPreferences updatePreferences( 276 long ownerId, int ownerType, long plid, java.lang.String portletId, 277 java.lang.String xml) 278 throws com.liferay.portal.kernel.exception.SystemException; 279 }