Class PortletPreferenceValueLocalServiceUtil
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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PortletPreferenceValueaddPortletPreferenceValue(PortletPreferenceValue portletPreferenceValue) Adds the portlet preference value to the database.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static PortletPreferenceValuecreatePortletPreferenceValue(long portletPreferenceValueId) Creates a new portlet preference value with the primary key.static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static PortletPreferenceValuedeletePortletPreferenceValue(long portletPreferenceValueId) Deletes the portlet preference value with the primary key from the database.static PortletPreferenceValuedeletePortletPreferenceValue(PortletPreferenceValue portletPreferenceValue) Deletes the portlet preference value from the database.static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <T> List<T>dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> 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> 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 longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static PortletPreferenceValuefetchPortletPreferenceValue(long portletPreferenceValueId) static ActionableDynamicQuerystatic StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static PortletPreferenceValuegetPortletPreferenceValue(long portletPreferenceValueId) Returns the portlet preference value with the primary key.static List<PortletPreferenceValue>getPortletPreferenceValues(int start, int end) Returns a range of all the portlet preference values.static intReturns the number of portlet preference values.static intgetPortletPreferenceValuesCount(long companyId, String name, String smallValue) static PortletPreferencesgetPreferences(PortletPreferences portletPreferences) static voidstatic PortletPreferenceValueupdatePortletPreferenceValue(PortletPreferenceValue portletPreferenceValue) Updates the portlet preference value in the database or adds it if it does not yet exist.
-
Constructor Details
-
PortletPreferenceValueLocalServiceUtil
public PortletPreferenceValueLocalServiceUtil()
-
-
Method Details
-
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(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createPortletPreferenceValue
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) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletPreferenceValueModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletPreferenceValueModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchPortletPreferenceValue
-
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- 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
Returns a range of all the portlet preference values.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletPreferenceValueModelImpl.- Parameters:
start- the lower bound of the range of portlet preference valuesend- 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
-
getPortletPreferenceValuesCount
-
getPreferences
-
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
-
setService
-