com.liferay.portal.kernel.service

Class PortletPreferenceValueLocalServiceUtil

java.lang.Object

com.liferay.portal.kernel.service.PortletPreferenceValueLocalServiceUtil

public class PortletPreferenceValueLocalServiceUtil
extends java.lang.Object

Provides the local service utility for PortletPreferenceValue. This utility wraps com.liferay.portal.service.impl.PortletPreferenceValueLocalServiceImpl and is an 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 Also:

PortletPreferenceValueLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
PortletPreferenceValueLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static PortletPreferenceValue	addPortletPreferenceValue(PortletPreferenceValue portletPreferenceValue) Adds the portlet preference value to the database.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static PortletPreferenceValue	createPortletPreferenceValue(long portletPreferenceValueId) Creates a new portlet preference value with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static PortletPreferenceValue	deletePortletPreferenceValue(long portletPreferenceValueId) Deletes the portlet preference value with the primary key from the database.
static PortletPreferenceValue	deletePortletPreferenceValue(PortletPreferenceValue portletPreferenceValue) Deletes the portlet preference value from the database.
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static PortletPreferenceValue	fetchPortletPreferenceValue(long portletPreferenceValueId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static PortletPreferenceValue	getPortletPreferenceValue(long portletPreferenceValueId) Returns the portlet preference value with the primary key.
static java.util.List<PortletPreferenceValue>	getPortletPreferenceValues(int start, int end) Returns a range of all the portlet preference values.
static int	getPortletPreferenceValuesCount() Returns the number of portlet preference values.
static javax.portlet.PortletPreferences	getPreferences(PortletPreferences portletPreferences)
static PortletPreferenceValueLocalService	getService()
static PortletPreferenceValue	updatePortletPreferenceValue(PortletPreferenceValue portletPreferenceValue) Updates the portlet preference value in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletPreferenceValueLocalServiceUtil

public PortletPreferenceValueLocalServiceUtil()

Method Detail

addPortletPreferenceValue

public static PortletPreferenceValue addPortletPreferenceValue(PortletPreferenceValue portletPreferenceValue)

Adds the portlet preference value to the database. Also notifies the appropriate model listeners.

Important: Inspect PortletPreferenceValueLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

portletPreferenceValue - the portlet preference value

Returns:

the portlet preference value that was added

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

createPortletPreferenceValue

public static PortletPreferenceValue createPortletPreferenceValue(long portletPreferenceValueId)

Creates a new portlet preference value with the primary key. Does not add the portlet preference value to the database.

Parameters:

portletPreferenceValueId - the primary key for the new portlet preference value

Returns:

the new portlet preference value

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deletePortletPreferenceValue

public static PortletPreferenceValue deletePortletPreferenceValue(long portletPreferenceValueId)
                                                           throws PortalException

Deletes the portlet preference value with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect PortletPreferenceValueLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

portletPreferenceValueId - the primary key of the portlet preference value

Returns:

the portlet preference value that was removed

Throws:

PortalException - if a portlet preference value with the primary key could not be found

deletePortletPreferenceValue

public static PortletPreferenceValue deletePortletPreferenceValue(PortletPreferenceValue portletPreferenceValue)

Deletes the portlet preference value from the database. Also notifies the appropriate model listeners.

Important: Inspect PortletPreferenceValueLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

portletPreferenceValue - the portlet preference value

Returns:

the portlet preference value that was removed

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

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 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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PortletPreferenceValueModelImpl.

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

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<T> orderByComparator)

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 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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PortletPreferenceValueModelImpl.

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchPortletPreferenceValue

public static PortletPreferenceValue fetchPortletPreferenceValue(long portletPreferenceValueId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getPortletPreferenceValue

public static PortletPreferenceValue getPortletPreferenceValue(long portletPreferenceValueId)
                                                        throws PortalException

Returns the portlet preference value with the primary key.

Parameters:

portletPreferenceValueId - the primary key of the portlet preference value

Returns:

the portlet preference value

Throws:

PortalException - if a portlet preference value with the primary key could not be found

getPortletPreferenceValues

public static java.util.List<PortletPreferenceValue> getPortletPreferenceValues(int start,
                                                                                int end)

Returns a range of all the portlet preference values.

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 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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PortletPreferenceValueModelImpl.

Parameters:

start - the lower bound of the range of portlet preference values

end - the upper bound of the range of portlet preference values (not inclusive)

Returns:

the range of portlet preference values

getPortletPreferenceValuesCount

public static int getPortletPreferenceValuesCount()

Returns the number of portlet preference values.

Returns:

the number of portlet preference values

getPreferences

public static javax.portlet.PortletPreferences getPreferences(PortletPreferences portletPreferences)

updatePortletPreferenceValue

public static PortletPreferenceValue updatePortletPreferenceValue(PortletPreferenceValue portletPreferenceValue)

Updates the portlet preference value in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect PortletPreferenceValueLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

portletPreferenceValue - the portlet preference value

Returns:

the portlet preference value that was updated

getService

public static PortletPreferenceValueLocalService getService()