Interface LayoutFriendlyURLLocalService
- All Superinterfaces:
BaseLocalService
,CTService<LayoutFriendlyURL>
,PersistedModelLocalService
- All Known Implementing Classes:
LayoutFriendlyURLLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddLayoutFriendlyURL
(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext) addLayoutFriendlyURL
(LayoutFriendlyURL layoutFriendlyURL) Adds the layout friendly url to the database.addLayoutFriendlyURLs
(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale, String> friendlyURLMap, ServiceContext serviceContext) createLayoutFriendlyURL
(long layoutFriendlyURLId) Creates a new layout friendly url with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteLayoutFriendlyURL
(long layoutFriendlyURLId) Deletes the layout friendly url with the primary key from the database.void
deleteLayoutFriendlyURL
(long plid, String languageId) deleteLayoutFriendlyURL
(LayoutFriendlyURL layoutFriendlyURL) Deletes the layout friendly url from the database.void
deleteLayoutFriendlyURLs
(long plid) deletePersistedModel
(PersistedModel persistedModel) <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.fetchFirstLayoutFriendlyURL
(long groupId, boolean privateLayout, String friendlyURL) fetchLayoutFriendlyURL
(long layoutFriendlyURLId) fetchLayoutFriendlyURL
(long groupId, boolean privateLayout, String friendlyURL, String languageId) fetchLayoutFriendlyURL
(long plid, String languageId) fetchLayoutFriendlyURL
(long plid, String languageId, boolean useDefault) fetchLayoutFriendlyURLByUuidAndGroupId
(String uuid, long groupId) Returns the layout friendly url matching the UUID and group.getExportActionableDynamicQuery
(PortletDataContext portletDataContext) getLayoutFriendlyURL
(long layoutFriendlyURLId) Returns the layout friendly url with the primary key.getLayoutFriendlyURL
(long groupId, boolean privateLayout, String friendlyURL, String languageId) getLayoutFriendlyURL
(long plid, String languageId) getLayoutFriendlyURL
(long plid, String languageId, boolean useDefault) getLayoutFriendlyURLByUuidAndGroupId
(String uuid, long groupId) Returns the layout friendly url matching the UUID and group.getLayoutFriendlyURLs
(int start, int end) Returns a range of all the layout friendly urls.getLayoutFriendlyURLs
(long plid) getLayoutFriendlyURLs
(long plid, String friendlyURL, int start, int end) getLayoutFriendlyURLs
(Group siteGroup, List<Layout> layouts, String languageId) getLayoutFriendlyURLsByUuidAndCompanyId
(String uuid, long companyId) Returns all the layout friendly urls matching the UUID and company.getLayoutFriendlyURLsByUuidAndCompanyId
(String uuid, long companyId, int start, int end, OrderByComparator<LayoutFriendlyURL> orderByComparator) Returns a range of layout friendly urls matching the UUID and company.int
Returns the number of layout friendly urls.int
getLayoutFriendlyURLsCount
(long companyId, String friendlyURL) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) updateLayoutFriendlyURL
(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext) updateLayoutFriendlyURL
(LayoutFriendlyURL layoutFriendlyURL) Updates the layout friendly url in the database or adds it if it does not yet exist.updateLayoutFriendlyURLs
(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale, String> friendlyURLMap, ServiceContext serviceContext) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<LayoutFriendlyURL>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addLayoutFriendlyURL
@Indexable(type=REINDEX) LayoutFriendlyURL addLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL) Adds the layout friendly url to the database. Also notifies the appropriate model listeners.Important: Inspect LayoutFriendlyURLLocalServiceImpl 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:
layoutFriendlyURL
- the layout friendly url- Returns:
- the layout friendly url that was added
-
addLayoutFriendlyURL
LayoutFriendlyURL addLayoutFriendlyURL(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addLayoutFriendlyURLs
List<LayoutFriendlyURL> addLayoutFriendlyURLs(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale, String> friendlyURLMap, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
createLayoutFriendlyURL
Creates a new layout friendly url with the primary key. Does not add the layout friendly url to the database.- Parameters:
layoutFriendlyURLId
- the primary key for the new layout friendly url- Returns:
- the new layout friendly url
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteLayoutFriendlyURL
@Indexable(type=DELETE) @SystemEvent(type=1) LayoutFriendlyURL deleteLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL) Deletes the layout friendly url from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutFriendlyURLLocalServiceImpl 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:
layoutFriendlyURL
- the layout friendly url- Returns:
- the layout friendly url that was removed
-
deleteLayoutFriendlyURL
@Indexable(type=DELETE) LayoutFriendlyURL deleteLayoutFriendlyURL(long layoutFriendlyURLId) throws PortalException Deletes the layout friendly url with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutFriendlyURLLocalServiceImpl 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:
layoutFriendlyURLId
- the primary key of the layout friendly url- Returns:
- the layout friendly url that was removed
- Throws:
PortalException
- if a layout friendly url with the primary key could not be found
-
deleteLayoutFriendlyURL
-
deleteLayoutFriendlyURLs
void deleteLayoutFriendlyURLs(long plid) -
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
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.LayoutFriendlyURLModelImpl
.- 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.LayoutFriendlyURLModelImpl
.- 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
-
fetchFirstLayoutFriendlyURL
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL fetchFirstLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL) -
fetchLayoutFriendlyURL
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL fetchLayoutFriendlyURL(long layoutFriendlyURLId) -
fetchLayoutFriendlyURL
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL fetchLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL, String languageId) -
fetchLayoutFriendlyURL
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL fetchLayoutFriendlyURL(long plid, String languageId) -
fetchLayoutFriendlyURL
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL fetchLayoutFriendlyURL(long plid, String languageId, boolean useDefault) -
fetchLayoutFriendlyURLByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL fetchLayoutFriendlyURLByUuidAndGroupId(String uuid, long groupId) Returns the layout friendly url matching the UUID and group.- Parameters:
uuid
- the layout friendly url's UUIDgroupId
- the primary key of the group- Returns:
- the matching layout friendly url, or
null
if a matching layout friendly url could not be found
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getLayoutFriendlyURL
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL getLayoutFriendlyURL(long layoutFriendlyURLId) throws PortalException Returns the layout friendly url with the primary key.- Parameters:
layoutFriendlyURLId
- the primary key of the layout friendly url- Returns:
- the layout friendly url
- Throws:
PortalException
- if a layout friendly url with the primary key could not be found
-
getLayoutFriendlyURL
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL getLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL, String languageId) throws NoSuchLayoutFriendlyURLException - Throws:
NoSuchLayoutFriendlyURLException
-
getLayoutFriendlyURL
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL getLayoutFriendlyURL(long plid, String languageId) throws PortalException - Throws:
PortalException
-
getLayoutFriendlyURL
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL getLayoutFriendlyURL(long plid, String languageId, boolean useDefault) throws PortalException - Throws:
PortalException
-
getLayoutFriendlyURLByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutFriendlyURL getLayoutFriendlyURLByUuidAndGroupId(String uuid, long groupId) throws PortalException Returns the layout friendly url matching the UUID and group.- Parameters:
uuid
- the layout friendly url's UUIDgroupId
- the primary key of the group- Returns:
- the matching layout friendly url
- Throws:
PortalException
- if a matching layout friendly url could not be found
-
getLayoutFriendlyURLs
-
getLayoutFriendlyURLs
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutFriendlyURL> getLayoutFriendlyURLs(int start, int end) Returns a range of all the layout friendly urls.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.LayoutFriendlyURLModelImpl
.- Parameters:
start
- the lower bound of the range of layout friendly urlsend
- the upper bound of the range of layout friendly urls (not inclusive)- Returns:
- the range of layout friendly urls
-
getLayoutFriendlyURLs
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid) -
getLayoutFriendlyURLs
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid, String friendlyURL, int start, int end) -
getLayoutFriendlyURLsByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutFriendlyURL> getLayoutFriendlyURLsByUuidAndCompanyId(String uuid, long companyId) Returns all the layout friendly urls matching the UUID and company.- Parameters:
uuid
- the UUID of the layout friendly urlscompanyId
- the primary key of the company- Returns:
- the matching layout friendly urls, or an empty list if no matches were found
-
getLayoutFriendlyURLsByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutFriendlyURL> getLayoutFriendlyURLsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<LayoutFriendlyURL> orderByComparator) Returns a range of layout friendly urls matching the UUID and company.- Parameters:
uuid
- the UUID of the layout friendly urlscompanyId
- the primary key of the companystart
- the lower bound of the range of layout friendly urlsend
- the upper bound of the range of layout friendly urls (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching layout friendly urls, or an empty list if no matches were found
-
getLayoutFriendlyURLsCount
Returns the number of layout friendly urls.- Returns:
- the number of layout friendly urls
-
getLayoutFriendlyURLsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutFriendlyURLsCount(long companyId, String friendlyURL) -
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
-
updateLayoutFriendlyURL
@Indexable(type=REINDEX) LayoutFriendlyURL updateLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL) Updates the layout friendly url in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect LayoutFriendlyURLLocalServiceImpl 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:
layoutFriendlyURL
- the layout friendly url- Returns:
- the layout friendly url that was updated
-
updateLayoutFriendlyURL
LayoutFriendlyURL updateLayoutFriendlyURL(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateLayoutFriendlyURLs
List<LayoutFriendlyURL> updateLayoutFriendlyURLs(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale, String> friendlyURLMap, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<LayoutFriendlyURL>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<LayoutFriendlyURL>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<LayoutFriendlyURL>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<LayoutFriendlyURL>
- Throws:
E extends Throwable
-