com.liferay.portal.kernel.service

Class PortalPreferenceValueLocalServiceUtil

java.lang.Object

com.liferay.portal.kernel.service.PortalPreferenceValueLocalServiceUtil

public class PortalPreferenceValueLocalServiceUtil
extends java.lang.Object

Provides the local service utility for PortalPreferenceValue. This utility wraps com.liferay.portal.service.impl.PortalPreferenceValueLocalServiceImpl 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:

PortalPreferenceValueLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
PortalPreferenceValueLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static PortalPreferenceValue	addPortalPreferenceValue(PortalPreferenceValue portalPreferenceValue) Adds the portal preference value to the database.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static PortalPreferenceValue	createPortalPreferenceValue(long portalPreferenceValueId) Creates a new portal preference value with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static PortalPreferenceValue	deletePortalPreferenceValue(long portalPreferenceValueId) Deletes the portal preference value with the primary key from the database.
static PortalPreferenceValue	deletePortalPreferenceValue(PortalPreferenceValue portalPreferenceValue) Deletes the portal 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 PortalPreferenceValue	fetchPortalPreferenceValue(long portalPreferenceValueId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static PortalPreferences	getPortalPreferences(PortalPreferences portalPreferences, boolean signedIn)
static PortalPreferenceValue	getPortalPreferenceValue(long portalPreferenceValueId) Returns the portal preference value with the primary key.
static java.util.List<PortalPreferenceValue>	getPortalPreferenceValues(int start, int end) Returns a range of all the portal preference values.
static int	getPortalPreferenceValuesCount() Returns the number of portal preference values.
static PortalPreferenceValueLocalService	getService()
static PortalPreferenceValue	updatePortalPreferenceValue(PortalPreferenceValue portalPreferenceValue) Updates the portal 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

PortalPreferenceValueLocalServiceUtil

public PortalPreferenceValueLocalServiceUtil()

Method Detail

addPortalPreferenceValue

public static PortalPreferenceValue addPortalPreferenceValue(PortalPreferenceValue portalPreferenceValue)

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

Important: Inspect PortalPreferenceValueLocalServiceImpl 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:

portalPreferenceValue - the portal preference value

Returns:

the portal preference value that was added

createPersistedModel

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

Throws:

PortalException

createPortalPreferenceValue

public static PortalPreferenceValue createPortalPreferenceValue(long portalPreferenceValueId)

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

Parameters:

portalPreferenceValueId - the primary key for the new portal preference value

Returns:

the new portal preference value

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deletePortalPreferenceValue

public static PortalPreferenceValue deletePortalPreferenceValue(long portalPreferenceValueId)
                                                         throws PortalException

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

Important: Inspect PortalPreferenceValueLocalServiceImpl 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:

portalPreferenceValueId - the primary key of the portal preference value

Returns:

the portal preference value that was removed

Throws:

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

deletePortalPreferenceValue

public static PortalPreferenceValue deletePortalPreferenceValue(PortalPreferenceValue portalPreferenceValue)

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

Important: Inspect PortalPreferenceValueLocalServiceImpl 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:

portalPreferenceValue - the portal preference value

Returns:

the portal 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.PortalPreferenceValueModelImpl.

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.PortalPreferenceValueModelImpl.

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

fetchPortalPreferenceValue

public static PortalPreferenceValue fetchPortalPreferenceValue(long portalPreferenceValueId)

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

getPortalPreferences

public static PortalPreferences getPortalPreferences(PortalPreferences portalPreferences,
                                                     boolean signedIn)

getPortalPreferenceValue

public static PortalPreferenceValue getPortalPreferenceValue(long portalPreferenceValueId)
                                                      throws PortalException

Returns the portal preference value with the primary key.

Parameters:

portalPreferenceValueId - the primary key of the portal preference value

Returns:

the portal preference value

Throws:

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

getPortalPreferenceValues

public static java.util.List<PortalPreferenceValue> getPortalPreferenceValues(int start,
                                                                              int end)

Returns a range of all the portal 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.PortalPreferenceValueModelImpl.

Parameters:

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

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

Returns:

the range of portal preference values

getPortalPreferenceValuesCount

public static int getPortalPreferenceValuesCount()

Returns the number of portal preference values.

Returns:

the number of portal preference values

updatePortalPreferenceValue

public static PortalPreferenceValue updatePortalPreferenceValue(PortalPreferenceValue portalPreferenceValue)

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

Important: Inspect PortalPreferenceValueLocalServiceImpl 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:

portalPreferenceValue - the portal preference value

Returns:

the portal preference value that was updated

getService

public static PortalPreferenceValueLocalService getService()