Interface PortalPreferencesLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
PortalPreferencesLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddPortalPreferences
(long ownerId, int ownerType, String defaultPreferences) addPortalPreferences
(PortalPreferences portalPreferences) Adds the portal preferences to the database.createPersistedModel
(Serializable primaryKeyObj) createPortalPreferences
(long portalPreferencesId) Creates a new portal preferences with the primary key.deletePersistedModel
(PersistedModel persistedModel) deletePortalPreferences
(long portalPreferencesId) Deletes the portal preferences with the primary key from the database.deletePortalPreferences
(PortalPreferences portalPreferences) Deletes the portal preferences from the database.<T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.fetchPortalPreferences
(long portalPreferencesId) fetchPortalPreferences
(long ownerId, int ownerType) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getPortalPreferences
(long portalPreferencesId) Returns the portal preferences with the primary key.getPortalPreferenceses
(int start, int end) Returns a range of all the portal preferenceses.int
Returns the number of portal preferenceses.getPreferences
(long ownerId, int ownerType) getPreferences
(long ownerId, int ownerType, String defaultPreferences) updatePortalPreferences
(PortalPreferences portalPreferences) Updates the portal preferences in the database or adds it if it does not yet exist.updatePreferences
(long ownerId, int ownerType, PortalPreferences portalPreferences) updatePreferences
(long ownerId, int ownerType, String xml) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addPortalPreferences
-
addPortalPreferences
@Indexable(type=REINDEX) PortalPreferences addPortalPreferences(PortalPreferences portalPreferences) 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
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- 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
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deletePortalPreferences
@Indexable(type=DELETE) 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
@Indexable(type=DELETE) PortalPreferences deletePortalPreferences(PortalPreferences portalPreferences) 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
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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
@Transactional(propagation=SUPPORTS, readOnly=true) <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.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.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
@Transactional(propagation=SUPPORTS, readOnly=true) <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.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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) 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
@Transactional(propagation=SUPPORTS, readOnly=true) PortalPreferences fetchPortalPreferences(long portalPreferencesId) -
fetchPortalPreferences
@Transactional(propagation=SUPPORTS, readOnly=true) PortalPreferences fetchPortalPreferences(long ownerId, int ownerType) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
getPortalPreferences
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortalPreferences> getPortalPreferenceses(int start, int end) Returns a range of all the portal preferenceses.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.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
Returns the number of portal preferenceses.- Returns:
- the number of portal preferenceses
-
getPreferences
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences getPreferences(long ownerId, int ownerType) -
getPreferences
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences getPreferences(long ownerId, int ownerType, String defaultPreferences) -
updatePortalPreferences
@Indexable(type=REINDEX) PortalPreferences updatePortalPreferences(PortalPreferences portalPreferences) 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
PortalPreferences updatePreferences(long ownerId, int ownerType, PortalPreferences portalPreferences) -
updatePreferences
-