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 PortletPreferenceValue
addPortletPreferenceValue
(PortletPreferenceValue portletPreferenceValue) Adds the portlet preference value to the database.static PersistedModel
createPersistedModel
(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 int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <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 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
static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static PortletPreferenceValue
getPortletPreferenceValue
(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 int
Returns the number of portlet preference values.static int
getPortletPreferenceValuesCount
(long companyId, String name, String smallValue) static PortletPreferences
getPreferences
(PortletPreferences portletPreferences) static void
static PortletPreferenceValue
updatePortletPreferenceValue
(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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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
-