Class PortalPreferenceValueLocalServiceUtil
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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PortalPreferenceValue
addPortalPreferenceValue
(PortalPreferenceValue portalPreferenceValue) Adds the portal preference value to the database.static PersistedModel
createPersistedModel
(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 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 PortalPreferenceValue
fetchPortalPreferenceValue
(long portalPreferenceValueId) static ActionableDynamicQuery
static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static PortalPreferences
getPortalPreferences
(PortalPreferences portalPreferences, boolean signedIn) static PortalPreferenceValue
getPortalPreferenceValue
(long portalPreferenceValueId) Returns the portal preference value with the primary key.static List<PortalPreferenceValue>
getPortalPreferenceValues
(int start, int end) Returns a range of all the portal preference values.static int
Returns the number of portal preference values.static void
static PortalPreferenceValue
updatePortalPreferenceValue
(PortalPreferenceValue portalPreferenceValue) Updates the portal preference value in the database or adds it if it does not yet exist.
-
Constructor Details
-
PortalPreferenceValueLocalServiceUtil
public PortalPreferenceValueLocalServiceUtil()
-
-
Method Details
-
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(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createPortalPreferenceValue
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) -
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.PortalPreferenceValueModelImpl
.- 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.PortalPreferenceValueModelImpl
.- 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
-
fetchPortalPreferenceValue
-
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- 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
Returns a range of all the portal 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.PortalPreferenceValueModelImpl
.- Parameters:
start
- the lower bound of the range of portal preference valuesend
- 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
-
setService
-