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 PortalPreferences. 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 PortalPreferencesLocalServiceUtil 034 * @see com.liferay.portal.service.base.PortalPreferencesLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface PortalPreferencesLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * 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. 047 */ 048 public com.liferay.portal.model.PortalPreferences addPortalPreferences( 049 long ownerId, int ownerType, java.lang.String defaultPreferences); 050 051 /** 052 * Adds the portal preferences to the database. Also notifies the appropriate model listeners. 053 * 054 * @param portalPreferences the portal preferences 055 * @return the portal preferences that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portal.model.PortalPreferences addPortalPreferences( 059 com.liferay.portal.model.PortalPreferences portalPreferences); 060 061 /** 062 * Creates a new portal preferences with the primary key. Does not add the portal preferences to the database. 063 * 064 * @param portalPreferencesId the primary key for the new portal preferences 065 * @return the new portal preferences 066 */ 067 public com.liferay.portal.model.PortalPreferences createPortalPreferences( 068 long portalPreferencesId); 069 070 /** 071 * @throws PortalException 072 */ 073 @Override 074 public com.liferay.portal.model.PersistedModel deletePersistedModel( 075 com.liferay.portal.model.PersistedModel persistedModel) 076 throws PortalException; 077 078 /** 079 * Deletes the portal preferences from the database. Also notifies the appropriate model listeners. 080 * 081 * @param portalPreferences the portal preferences 082 * @return the portal preferences that was removed 083 */ 084 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 085 public com.liferay.portal.model.PortalPreferences deletePortalPreferences( 086 com.liferay.portal.model.PortalPreferences portalPreferences); 087 088 /** 089 * Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners. 090 * 091 * @param portalPreferencesId the primary key of the portal preferences 092 * @return the portal preferences that was removed 093 * @throws PortalException if a portal preferences 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.PortalPreferences deletePortalPreferences( 097 long portalPreferencesId) 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.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. 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.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. 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.PortalPreferences fetchPortalPreferences( 166 long portalPreferencesId); 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 /** 187 * Returns the portal preferences with the primary key. 188 * 189 * @param portalPreferencesId the primary key of the portal preferences 190 * @return the portal preferences 191 * @throws PortalException if a portal preferences with the primary key could not be found 192 */ 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public com.liferay.portal.model.PortalPreferences getPortalPreferences( 195 long portalPreferencesId) throws PortalException; 196 197 /** 198 * Returns a range of all the portal preferenceses. 199 * 200 * <p> 201 * 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. 202 * </p> 203 * 204 * @param start the lower bound of the range of portal preferenceses 205 * @param end the upper bound of the range of portal preferenceses (not inclusive) 206 * @return the range of portal preferenceses 207 */ 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public java.util.List<com.liferay.portal.model.PortalPreferences> getPortalPreferenceses( 210 int start, int end); 211 212 /** 213 * Returns the number of portal preferenceses. 214 * 215 * @return the number of portal preferenceses 216 */ 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public int getPortalPreferencesesCount(); 219 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public javax.portlet.PortletPreferences getPreferences(long ownerId, 222 int ownerType); 223 224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 225 public javax.portlet.PortletPreferences getPreferences(long ownerId, 226 int ownerType, java.lang.String defaultPreferences); 227 228 /** 229 * Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 230 * 231 * @param portalPreferences the portal preferences 232 * @return the portal preferences that was updated 233 */ 234 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 235 public com.liferay.portal.model.PortalPreferences updatePortalPreferences( 236 com.liferay.portal.model.PortalPreferences portalPreferences); 237 238 public com.liferay.portal.model.PortalPreferences updatePreferences( 239 long ownerId, int ownerType, 240 com.liferay.portlet.PortalPreferences portalPreferences); 241 242 public com.liferay.portal.model.PortalPreferences updatePreferences( 243 long ownerId, int ownerType, java.lang.String xml); 244 }