com.liferay.portal.service.PortalPreferencesLocalServiceUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service;
import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
* Provides the local service utility for PortalPreferences. This utility wraps
* {@link com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl} and is the
* primary access point for service operations in application layer code running
* on the local server. 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.
*
* @author Brian Wing Shun Chan
* @see PortalPreferencesLocalService
* @see com.liferay.portal.service.base.PortalPreferencesLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl
* @generated
*/
public class PortalPreferencesLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
/**
* Adds the portal preferences to the database. Also notifies the appropriate model listeners.
*
* @param portalPreferences the portal preferences
* @return the portal preferences that was added
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.PortalPreferences addPortalPreferences(
com.liferay.portal.model.PortalPreferences portalPreferences)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().addPortalPreferences(portalPreferences);
}
/**
* Creates a new portal preferences with the primary key. Does not add the portal preferences to the database.
*
* @param portalPreferencesId the primary key for the new portal preferences
* @return the new portal preferences
*/
public static com.liferay.portal.model.PortalPreferences createPortalPreferences(
long portalPreferencesId) {
return getService().createPortalPreferences(portalPreferencesId);
}
/**
* Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param portalPreferencesId the primary key of the portal preferences
* @return the portal preferences that was removed
* @throws PortalException if a portal preferences with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.PortalPreferences deletePortalPreferences(
long portalPreferencesId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().deletePortalPreferences(portalPreferencesId);
}
/**
* Deletes the portal preferences from the database. Also notifies the appropriate model listeners.
*
* @param portalPreferences the portal preferences
* @return the portal preferences that was removed
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.PortalPreferences deletePortalPreferences(
com.liferay.portal.model.PortalPreferences portalPreferences)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().deletePortalPreferences(portalPreferences);
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQuery(dynamicQuery);
}
/**
* Performs a dynamic query on the database and returns a range of the matching rows.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end 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 orderByComparator 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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQuery(dynamicQuery, start, end);
}
/**
* Performs a dynamic query on the database and returns an ordered range of the matching rows.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end 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 orderByComparator 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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.dynamicQuery(dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static com.liferay.portal.model.PortalPreferences fetchPortalPreferences(
long portalPreferencesId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchPortalPreferences(portalPreferencesId);
}
/**
* Returns the portal preferences with the primary key.
*
* @param portalPreferencesId the primary key of the portal preferences
* @return the portal preferences
* @throws PortalException if a portal preferences with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.PortalPreferences getPortalPreferences(
long portalPreferencesId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getPortalPreferences(portalPreferencesId);
}
public static com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getPersistedModel(primaryKeyObj);
}
/**
* Returns a range of all the portal preferenceses.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end 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 orderByComparator 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.
*
*
* @param start the lower bound of the range of portal preferenceses
* @param end the upper bound of the range of portal preferenceses (not inclusive)
* @return the range of portal preferenceses
* @throws SystemException if a system exception occurred
*/
public static java.util.List getPortalPreferenceses(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getPortalPreferenceses(start, end);
}
/**
* Returns the number of portal preferenceses.
*
* @return the number of portal preferenceses
* @throws SystemException if a system exception occurred
*/
public static int getPortalPreferencesesCount()
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getPortalPreferencesesCount();
}
/**
* Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param portalPreferences the portal preferences
* @return the portal preferences that was updated
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.PortalPreferences updatePortalPreferences(
com.liferay.portal.model.PortalPreferences portalPreferences)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().updatePortalPreferences(portalPreferences);
}
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public static java.lang.String getBeanIdentifier() {
return getService().getBeanIdentifier();
}
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public static void setBeanIdentifier(java.lang.String beanIdentifier) {
getService().setBeanIdentifier(beanIdentifier);
}
public static com.liferay.portal.model.PortalPreferences addPortalPreferences(
long ownerId, int ownerType, java.lang.String defaultPreferences)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.addPortalPreferences(ownerId, ownerType, defaultPreferences);
}
/**
* @deprecated As of 6.2.0, replaced by {@link #addPortalPreferences(long,
int, String)}
*/
public static com.liferay.portal.model.PortalPreferences addPortalPreferences(
long companyId, long ownerId, int ownerType,
java.lang.String defaultPreferences)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.addPortalPreferences(companyId, ownerId, ownerType,
defaultPreferences);
}
public static javax.portlet.PortletPreferences getPreferences(
long ownerId, int ownerType)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getPreferences(ownerId, ownerType);
}
public static javax.portlet.PortletPreferences getPreferences(
long ownerId, int ownerType, java.lang.String defaultPreferences)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getPreferences(ownerId, ownerType, defaultPreferences);
}
/**
* @deprecated As of 6.2.0, replaced by {@link #getPreferences(long, int)}
*/
public static javax.portlet.PortletPreferences getPreferences(
long companyId, long ownerId, int ownerType)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getPreferences(companyId, ownerId, ownerType);
}
/**
* @deprecated As of 6.2.0, replaced by {@link #getPreferences(long, int,
String)}
*/
public static javax.portlet.PortletPreferences getPreferences(
long companyId, long ownerId, int ownerType,
java.lang.String defaultPreferences)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getPreferences(companyId, ownerId, ownerType,
defaultPreferences);
}
public static com.liferay.portal.model.PortalPreferences updatePreferences(
long ownerId, int ownerType,
com.liferay.portlet.PortalPreferences portalPreferences)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.updatePreferences(ownerId, ownerType, portalPreferences);
}
public static com.liferay.portal.model.PortalPreferences updatePreferences(
long ownerId, int ownerType, java.lang.String xml)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().updatePreferences(ownerId, ownerType, xml);
}
public static PortalPreferencesLocalService getService() {
if (_service == null) {
_service = (PortalPreferencesLocalService)PortalBeanLocatorUtil.locate(PortalPreferencesLocalService.class.getName());
ReferenceRegistry.registerReference(PortalPreferencesLocalServiceUtil.class,
"_service");
}
return _service;
}
/**
* @deprecated As of 6.2.0
*/
public void setService(PortalPreferencesLocalService service) {
}
private static PortalPreferencesLocalService _service;
}