001 /** 002 * Copyright (c) 2000-2013 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.transaction.Isolation; 022 import com.liferay.portal.kernel.transaction.Propagation; 023 import com.liferay.portal.kernel.transaction.Transactional; 024 025 /** 026 * Provides the local service interface for PortalPreferences. Methods of this 027 * service will not have security checks based on the propagated JAAS 028 * credentials because this service can only be accessed from within the same 029 * VM. 030 * 031 * @author Brian Wing Shun Chan 032 * @see PortalPreferencesLocalServiceUtil 033 * @see com.liferay.portal.service.base.PortalPreferencesLocalServiceBaseImpl 034 * @see com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl 035 * @generated 036 */ 037 @ProviderType 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface PortalPreferencesLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link PortalPreferencesLocalServiceUtil} to access the portal preferences local service. Add custom service methods to {@link com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Adds the portal preferences to the database. Also notifies the appropriate model listeners. 050 * 051 * @param portalPreferences the portal preferences 052 * @return the portal preferences that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portal.model.PortalPreferences addPortalPreferences( 056 com.liferay.portal.model.PortalPreferences portalPreferences) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new portal preferences with the primary key. Does not add the portal preferences to the database. 061 * 062 * @param portalPreferencesId the primary key for the new portal preferences 063 * @return the new portal preferences 064 */ 065 public com.liferay.portal.model.PortalPreferences createPortalPreferences( 066 long portalPreferencesId); 067 068 /** 069 * Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param portalPreferencesId the primary key of the portal preferences 072 * @return the portal preferences that was removed 073 * @throws PortalException if a portal preferences with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portal.model.PortalPreferences deletePortalPreferences( 077 long portalPreferencesId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the portal preferences from the database. Also notifies the appropriate model listeners. 083 * 084 * @param portalPreferences the portal preferences 085 * @return the portal preferences that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portal.model.PortalPreferences deletePortalPreferences( 089 com.liferay.portal.model.PortalPreferences portalPreferences) 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.portal.model.impl.PortalPreferencesModelImpl}. 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.portal.model.impl.PortalPreferencesModelImpl}. 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 /** 157 * Returns the number of rows that match the dynamic query. 158 * 159 * @param dynamicQuery the dynamic query 160 * @param projection the projection to apply to the query 161 * @return the number of rows that match the dynamic query 162 * @throws SystemException if a system exception occurred 163 */ 164 public long dynamicQueryCount( 165 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 166 com.liferay.portal.kernel.dao.orm.Projection projection) 167 throws com.liferay.portal.kernel.exception.SystemException; 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.model.PortalPreferences fetchPortalPreferences( 171 long portalPreferencesId) 172 throws com.liferay.portal.kernel.exception.SystemException; 173 174 /** 175 * Returns the portal preferences with the primary key. 176 * 177 * @param portalPreferencesId the primary key of the portal preferences 178 * @return the portal preferences 179 * @throws PortalException if a portal preferences with the primary key could not be found 180 * @throws SystemException if a system exception occurred 181 */ 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.model.PortalPreferences getPortalPreferences( 184 long portalPreferencesId) 185 throws com.liferay.portal.kernel.exception.PortalException, 186 com.liferay.portal.kernel.exception.SystemException; 187 188 @Override 189 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 190 public com.liferay.portal.model.PersistedModel getPersistedModel( 191 java.io.Serializable primaryKeyObj) 192 throws com.liferay.portal.kernel.exception.PortalException, 193 com.liferay.portal.kernel.exception.SystemException; 194 195 /** 196 * Returns a range of all the portal preferenceses. 197 * 198 * <p> 199 * 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.PortalPreferencesModelImpl}. 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. 200 * </p> 201 * 202 * @param start the lower bound of the range of portal preferenceses 203 * @param end the upper bound of the range of portal preferenceses (not inclusive) 204 * @return the range of portal preferenceses 205 * @throws SystemException if a system exception occurred 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public java.util.List<com.liferay.portal.model.PortalPreferences> getPortalPreferenceses( 209 int start, int end) 210 throws com.liferay.portal.kernel.exception.SystemException; 211 212 /** 213 * Returns the number of portal preferenceses. 214 * 215 * @return the number of portal preferenceses 216 * @throws SystemException if a system exception occurred 217 */ 218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 219 public int getPortalPreferencesesCount() 220 throws com.liferay.portal.kernel.exception.SystemException; 221 222 /** 223 * Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 224 * 225 * @param portalPreferences the portal preferences 226 * @return the portal preferences that was updated 227 * @throws SystemException if a system exception occurred 228 */ 229 public com.liferay.portal.model.PortalPreferences updatePortalPreferences( 230 com.liferay.portal.model.PortalPreferences portalPreferences) 231 throws com.liferay.portal.kernel.exception.SystemException; 232 233 /** 234 * Returns the Spring bean ID for this bean. 235 * 236 * @return the Spring bean ID for this bean 237 */ 238 public java.lang.String getBeanIdentifier(); 239 240 /** 241 * Sets the Spring bean ID for this bean. 242 * 243 * @param beanIdentifier the Spring bean ID for this bean 244 */ 245 public void setBeanIdentifier(java.lang.String beanIdentifier); 246 247 public com.liferay.portal.model.PortalPreferences addPortalPreferences( 248 long ownerId, int ownerType, java.lang.String defaultPreferences) 249 throws com.liferay.portal.kernel.exception.SystemException; 250 251 /** 252 * @deprecated As of 6.2.0, replaced by {@link #addPortalPreferences(long, 253 int, String)} 254 */ 255 public com.liferay.portal.model.PortalPreferences addPortalPreferences( 256 long companyId, long ownerId, int ownerType, 257 java.lang.String defaultPreferences) 258 throws com.liferay.portal.kernel.exception.SystemException; 259 260 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 261 public javax.portlet.PortletPreferences getPreferences(long ownerId, 262 int ownerType) 263 throws com.liferay.portal.kernel.exception.SystemException; 264 265 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 266 public javax.portlet.PortletPreferences getPreferences(long ownerId, 267 int ownerType, java.lang.String defaultPreferences) 268 throws com.liferay.portal.kernel.exception.SystemException; 269 270 /** 271 * @deprecated As of 6.2.0, replaced by {@link #getPreferences(long, int)} 272 */ 273 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 274 public javax.portlet.PortletPreferences getPreferences(long companyId, 275 long ownerId, int ownerType) 276 throws com.liferay.portal.kernel.exception.SystemException; 277 278 /** 279 * @deprecated As of 6.2.0, replaced by {@link #getPreferences(long, int, 280 String)} 281 */ 282 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 283 public javax.portlet.PortletPreferences getPreferences(long companyId, 284 long ownerId, int ownerType, java.lang.String defaultPreferences) 285 throws com.liferay.portal.kernel.exception.SystemException; 286 287 public com.liferay.portal.model.PortalPreferences updatePreferences( 288 long ownerId, int ownerType, 289 com.liferay.portlet.PortalPreferences portalPreferences) 290 throws com.liferay.portal.kernel.exception.SystemException; 291 292 public com.liferay.portal.model.PortalPreferences updatePreferences( 293 long ownerId, int ownerType, java.lang.String xml) 294 throws com.liferay.portal.kernel.exception.SystemException; 295 }