com.liferay.portal.service
Class PortalPreferencesLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.PortalPreferencesLocalServiceUtil

public class PortalPreferencesLocalServiceUtil
extends Object

The utility for the portal preferences local service. This utility wraps PortalPreferencesLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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.

See Also:

PortalPreferencesLocalService, PortalPreferencesLocalServiceBaseImpl, PortalPreferencesLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

PortalPreferencesLocalServiceUtil()

Method Summary

static PortalPreferences	addPortalPreferences(long companyId, long ownerId, int ownerType, String defaultPreferences)
static PortalPreferences	addPortalPreferences(PortalPreferences portalPreferences) Adds the portal preferences to the database.
static PortalPreferences	createPortalPreferences(long portalPreferencesId) Creates a new portal preferences with the primary key.
static PortalPreferences	deletePortalPreferences(long portalPreferencesId) Deletes the portal preferences with the primary key from the database.
static PortalPreferences	deletePortalPreferences(PortalPreferences portalPreferences) Deletes the portal preferences from the database.
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static PortalPreferences	fetchPortalPreferences(long portalPreferencesId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static PortalPreferences	getPortalPreferences(long portalPreferencesId) Returns the portal preferences with the primary key.
static List<PortalPreferences>	getPortalPreferenceses(int start, int end) Returns a range of all the portal preferenceses.
static int	getPortalPreferencesesCount() Returns the number of portal preferenceses.
static PortletPreferences	getPreferences(long companyId, long ownerId, int ownerType)
static PortletPreferences	getPreferences(long companyId, long ownerId, int ownerType, String defaultPreferences)
static PortalPreferencesLocalService	getService()
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(PortalPreferencesLocalService service) Deprecated.
static PortalPreferences	updatePortalPreferences(PortalPreferences portalPreferences) Updates the portal preferences in the database or adds it if it does not yet exist.
static PortalPreferences	updatePortalPreferences(PortalPreferences portalPreferences, boolean merge) Updates the portal preferences in the database or adds it if it does not yet exist.
static PortalPreferences	updatePreferences(long ownerId, int ownerType, PortalPreferences portalPreferences)
static PortalPreferences	updatePreferences(long ownerId, int ownerType, String xml)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortalPreferencesLocalServiceUtil

public PortalPreferencesLocalServiceUtil()

Method Detail

addPortalPreferences

public static PortalPreferences addPortalPreferences(PortalPreferences portalPreferences)
                                              throws SystemException

Adds the portal preferences to the database. Also notifies the appropriate model listeners.

Parameters:

portalPreferences - the portal preferences

Returns:

the portal preferences that was added

Throws:

SystemException - if a system exception occurred

createPortalPreferences

public static PortalPreferences createPortalPreferences(long portalPreferencesId)

Creates a new portal preferences with the primary key. Does not add the portal preferences to the database.

Parameters:

portalPreferencesId - the primary key for the new portal preferences

Returns:

the new portal preferences

deletePortalPreferences

public static PortalPreferences deletePortalPreferences(long portalPreferencesId)
                                                 throws PortalException,
                                                        SystemException

Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

portalPreferencesId - the primary key of the portal preferences

Returns:

the portal preferences that was removed

Throws:

PortalException - if a portal preferences with the primary key could not be found

SystemException - if a system exception occurred

deletePortalPreferences

public static PortalPreferences deletePortalPreferences(PortalPreferences portalPreferences)
                                                 throws SystemException

Deletes the portal preferences from the database. Also notifies the appropriate model listeners.

Parameters:

portalPreferences - the portal preferences

Returns:

the portal preferences that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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 QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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 QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchPortalPreferences

public static PortalPreferences fetchPortalPreferences(long portalPreferencesId)
                                                throws SystemException

Throws:

SystemException

getPortalPreferences

public static PortalPreferences getPortalPreferences(long portalPreferencesId)
                                              throws PortalException,
                                                     SystemException

Returns the portal preferences with the primary key.

Parameters:

portalPreferencesId - the primary key of the portal preferences

Returns:

the portal preferences

Throws:

PortalException - if a portal preferences with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getPortalPreferenceses

public static List<PortalPreferences> getPortalPreferenceses(int start,
                                                             int end)
                                                      throws SystemException

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 QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of portal preferenceses

end - the upper bound of the range of portal preferenceses (not inclusive)

Returns:

the range of portal preferenceses

Throws:

SystemException - if a system exception occurred

getPortalPreferencesesCount

public static int getPortalPreferencesesCount()
                                       throws SystemException

Returns the number of portal preferenceses.

Returns:

the number of portal preferenceses

Throws:

SystemException - if a system exception occurred

updatePortalPreferences

public static PortalPreferences updatePortalPreferences(PortalPreferences portalPreferences)
                                                 throws SystemException

Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

portalPreferences - the portal preferences

Returns:

the portal preferences that was updated

Throws:

SystemException - if a system exception occurred

updatePortalPreferences

public static PortalPreferences updatePortalPreferences(PortalPreferences portalPreferences,
                                                        boolean merge)
                                                 throws SystemException

Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

portalPreferences - the portal preferences

merge - whether to merge the portal preferences with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the portal preferences that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addPortalPreferences

public static PortalPreferences addPortalPreferences(long companyId,
                                                     long ownerId,
                                                     int ownerType,
                                                     String defaultPreferences)
                                              throws SystemException

Throws:

SystemException

getPreferences

public static PortletPreferences getPreferences(long companyId,
                                                long ownerId,
                                                int ownerType)
                                         throws SystemException

Throws:

SystemException

getPreferences

public static PortletPreferences getPreferences(long companyId,
                                                long ownerId,
                                                int ownerType,
                                                String defaultPreferences)
                                         throws SystemException

Throws:

SystemException

updatePreferences

public static PortalPreferences updatePreferences(long ownerId,
                                                  int ownerType,
                                                  PortalPreferences portalPreferences)
                                           throws SystemException

Throws:

SystemException

updatePreferences

public static PortalPreferences updatePreferences(long ownerId,
                                                  int ownerType,
                                                  String xml)
                                           throws SystemException

Throws:

SystemException

getService

public static PortalPreferencesLocalService getService()

setService

public void setService(PortalPreferencesLocalService service)

Deprecated.