Class PortalPreferencesLocalServiceUtil
com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl 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 PortalPreferencesaddPortalPreferences(long ownerId, int ownerType, String defaultPreferences) static PortalPreferencesaddPortalPreferences(PortalPreferences portalPreferences) Adds the portal preferences to the database.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static PortalPreferencescreatePortalPreferences(long portalPreferencesId) Creates a new portal preferences with the primary key.static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static PortalPreferencesdeletePortalPreferences(long portalPreferencesId) Deletes the portal preferences with the primary key from the database.static PortalPreferencesdeletePortalPreferences(PortalPreferences portalPreferences) Deletes the portal preferences 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 PortalPreferencesfetchPortalPreferences(long portalPreferencesId) static PortalPreferencesfetchPortalPreferences(long ownerId, int ownerType) static ActionableDynamicQuerystatic StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static PortalPreferencesgetPortalPreferences(long portalPreferencesId) Returns the portal preferences with the primary key.static List<PortalPreferences>getPortalPreferenceses(int start, int end) Returns a range of all the portal preferenceses.static intReturns the number of portal preferenceses.static PortletPreferencesgetPreferences(long ownerId, int ownerType) static PortletPreferencesgetPreferences(long ownerId, int ownerType, String defaultPreferences) static voidsetService(PortalPreferencesLocalService service) static PortalPreferencesupdatePortalPreferences(PortalPreferences portalPreferences) Updates the portal preferences in the database or adds it if it does not yet exist.static PortalPreferencesupdatePreferences(long ownerId, int ownerType, PortalPreferences portalPreferences) static PortalPreferencesupdatePreferences(long ownerId, int ownerType, String xml)
-
Constructor Details
-
PortalPreferencesLocalServiceUtil
public PortalPreferencesLocalServiceUtil()
-
-
Method Details
-
addPortalPreferences
public static PortalPreferences addPortalPreferences(long ownerId, int ownerType, String defaultPreferences) -
addPortalPreferences
Adds the portal preferences to the database. Also notifies the appropriate model listeners.Important: Inspect PortalPreferencesLocalServiceImpl 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:
portalPreferences- the portal preferences- Returns:
- the portal preferences that was added
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createPortalPreferences
Creates a new portal preferences with the primary key. Does not add the portal preferences to the database.- Parameters:
portalPreferencesId- the primary key for the new portal preferences- Returns:
- the new portal preferences
-
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deletePortalPreferences
public static PortalPreferences deletePortalPreferences(long portalPreferencesId) throws PortalException Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect PortalPreferencesLocalServiceImpl 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:
portalPreferencesId- the primary key of the portal preferences- Returns:
- the portal preferences that was removed
- Throws:
PortalException- if a portal preferences with the primary key could not be found
-
deletePortalPreferences
Deletes the portal preferences from the database. Also notifies the appropriate model listeners.Important: Inspect PortalPreferencesLocalServiceImpl 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:
portalPreferences- the portal preferences- Returns:
- the portal preferences 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.PortalPreferencesModelImpl.- 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.PortalPreferencesModelImpl.- 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
-
fetchPortalPreferences
-
fetchPortalPreferences
-
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getPortalPreferences
public static PortalPreferences getPortalPreferences(long portalPreferencesId) throws PortalException Returns the portal preferences with the primary key.- Parameters:
portalPreferencesId- the primary key of the portal preferences- Returns:
- the portal preferences
- Throws:
PortalException- if a portal preferences with the primary key could not be found
-
getPortalPreferenceses
Returns a range of all the portal preferenceses.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.PortalPreferencesModelImpl.- Parameters:
start- the lower bound of the range of portal preferencesesend- the upper bound of the range of portal preferenceses (not inclusive)- Returns:
- the range of portal preferenceses
-
getPortalPreferencesesCount
public static int getPortalPreferencesesCount()Returns the number of portal preferenceses.- Returns:
- the number of portal preferenceses
-
getPreferences
-
getPreferences
public static PortletPreferences getPreferences(long ownerId, int ownerType, String defaultPreferences) -
updatePortalPreferences
Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PortalPreferencesLocalServiceImpl 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:
portalPreferences- the portal preferences- Returns:
- the portal preferences that was updated
-
updatePreferences
public static PortalPreferences updatePreferences(long ownerId, int ownerType, PortalPreferences portalPreferences) -
updatePreferences
-
getService
-
setService
-