Class LayoutFriendlyURLLocalServiceUtil
com.liferay.portal.service.impl.LayoutFriendlyURLLocalServiceImpl 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 LayoutFriendlyURLaddLayoutFriendlyURL(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext) static LayoutFriendlyURLaddLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL) Adds the layout friendly url to the database.static List<LayoutFriendlyURL>addLayoutFriendlyURLs(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale, String> friendlyURLMap, ServiceContext serviceContext) static LayoutFriendlyURLcreateLayoutFriendlyURL(long layoutFriendlyURLId) Creates a new layout friendly url with the primary key.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static LayoutFriendlyURLdeleteLayoutFriendlyURL(long layoutFriendlyURLId) Deletes the layout friendly url with the primary key from the database.static voiddeleteLayoutFriendlyURL(long plid, String languageId) static LayoutFriendlyURLdeleteLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL) Deletes the layout friendly url from the database.static voiddeleteLayoutFriendlyURLs(long plid) static PersistedModeldeletePersistedModel(PersistedModel persistedModel) 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 LayoutFriendlyURLfetchFirstLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL) static LayoutFriendlyURLfetchLayoutFriendlyURL(long layoutFriendlyURLId) static LayoutFriendlyURLfetchLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL, String languageId) static LayoutFriendlyURLfetchLayoutFriendlyURL(long plid, String languageId) static LayoutFriendlyURLfetchLayoutFriendlyURL(long plid, String languageId, boolean useDefault) static LayoutFriendlyURLfetchLayoutFriendlyURLByUuidAndGroupId(String uuid, long groupId) Returns the layout friendly url matching the UUID and group.static ActionableDynamicQuerystatic ExportActionableDynamicQuerygetExportActionableDynamicQuery(PortletDataContext portletDataContext) static LayoutFriendlyURLgetLayoutFriendlyURL(long layoutFriendlyURLId) Returns the layout friendly url with the primary key.static LayoutFriendlyURLgetLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL, String languageId) static LayoutFriendlyURLgetLayoutFriendlyURL(long plid, String languageId) static LayoutFriendlyURLgetLayoutFriendlyURL(long plid, String languageId, boolean useDefault) static LayoutFriendlyURLgetLayoutFriendlyURLByUuidAndGroupId(String uuid, long groupId) Returns the layout friendly url matching the UUID and group.static List<LayoutFriendlyURL>getLayoutFriendlyURLs(int start, int end) Returns a range of all the layout friendly urls.static List<LayoutFriendlyURL>getLayoutFriendlyURLs(long plid) static List<LayoutFriendlyURL>getLayoutFriendlyURLs(long plid, String friendlyURL, int start, int end) getLayoutFriendlyURLs(Group siteGroup, List<Layout> layouts, String languageId) static List<LayoutFriendlyURL>getLayoutFriendlyURLsByUuidAndCompanyId(String uuid, long companyId) Returns all the layout friendly urls matching the UUID and company.static 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.static intReturns the number of layout friendly urls.static intgetLayoutFriendlyURLsCount(long companyId, String friendlyURL) static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static voidsetService(LayoutFriendlyURLLocalService service) static LayoutFriendlyURLupdateLayoutFriendlyURL(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext) static LayoutFriendlyURLupdateLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL) Updates the layout friendly url in the database or adds it if it does not yet exist.static List<LayoutFriendlyURL>updateLayoutFriendlyURLs(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale, String> friendlyURLMap, ServiceContext serviceContext)
-
Constructor Details
-
LayoutFriendlyURLLocalServiceUtil
public LayoutFriendlyURLLocalServiceUtil()
-
-
Method Details
-
addLayoutFriendlyURL
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
public static LayoutFriendlyURL addLayoutFriendlyURL(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addLayoutFriendlyURLs
public static 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteLayoutFriendlyURL
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
public static 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
public static void deleteLayoutFriendlyURLs(long plid) -
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
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.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
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.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
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
-
fetchFirstLayoutFriendlyURL
public static LayoutFriendlyURL fetchFirstLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL) -
fetchLayoutFriendlyURL
-
fetchLayoutFriendlyURL
public static LayoutFriendlyURL fetchLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL, String languageId) -
fetchLayoutFriendlyURL
-
fetchLayoutFriendlyURL
public static LayoutFriendlyURL fetchLayoutFriendlyURL(long plid, String languageId, boolean useDefault) -
fetchLayoutFriendlyURLByUuidAndGroupId
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
nullif a matching layout friendly url could not be found
-
getActionableDynamicQuery
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
-
getLayoutFriendlyURL
public static 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
public static LayoutFriendlyURL getLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL, String languageId) throws NoSuchLayoutFriendlyURLException - Throws:
NoSuchLayoutFriendlyURLException
-
getLayoutFriendlyURL
public static LayoutFriendlyURL getLayoutFriendlyURL(long plid, String languageId) throws PortalException - Throws:
PortalException
-
getLayoutFriendlyURL
public static LayoutFriendlyURL getLayoutFriendlyURL(long plid, String languageId, boolean useDefault) throws PortalException - Throws:
PortalException
-
getLayoutFriendlyURLByUuidAndGroupId
public static 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
Returns a range of all the layout friendly urls.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.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
-
getLayoutFriendlyURLs
public static List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid, String friendlyURL, int start, int end) -
getLayoutFriendlyURLsByUuidAndCompanyId
public static 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
public static 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
public static int getLayoutFriendlyURLsCount()Returns the number of layout friendly urls.- Returns:
- the number of layout friendly urls
-
getLayoutFriendlyURLsCount
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
updateLayoutFriendlyURL
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
public static LayoutFriendlyURL updateLayoutFriendlyURL(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateLayoutFriendlyURLs
public static List<LayoutFriendlyURL> updateLayoutFriendlyURLs(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale, String> friendlyURLMap, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
getService
-
setService
-