Class SiteFriendlyURLLocalServiceUtil
com.liferay.site.service.impl.SiteFriendlyURLLocalServiceImpl 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.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic SiteFriendlyURLaddSiteFriendlyURL(long userId, long companyId, long groupId, String friendlyURL, String languageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static SiteFriendlyURLaddSiteFriendlyURL(SiteFriendlyURL siteFriendlyURL) Adds the site friendly url to the database.static List<SiteFriendlyURL> addSiteFriendlyURLs(long userId, long companyId, long groupId, Map<Locale, String> friendlyURLMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static SiteFriendlyURLcreateSiteFriendlyURL(long siteFriendlyURLId) Creates a new site friendly url with the primary key.static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static SiteFriendlyURLdeleteSiteFriendlyURL(long siteFriendlyURLId) Deletes the site friendly url with the primary key from the database.static SiteFriendlyURLdeleteSiteFriendlyURL(long companyId, long groupId, String languageId) static SiteFriendlyURLdeleteSiteFriendlyURL(SiteFriendlyURL siteFriendlyURL) Deletes the site friendly url from the database.static voiddeleteSiteFriendlyURLs(long companyId, long groupId) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.static SiteFriendlyURLfetchSiteFriendlyURL(long siteFriendlyURLId) static SiteFriendlyURLfetchSiteFriendlyURL(long companyId, long groupId, String languageId) static SiteFriendlyURLfetchSiteFriendlyURLByFriendlyURL(long companyId, String friendlyURL) static SiteFriendlyURLfetchSiteFriendlyURLByUuidAndGroupId(String uuid, long groupId) Returns the site friendly url matching the UUID and group.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static SiteFriendlyURLLocalServicestatic SiteFriendlyURLgetSiteFriendlyURL(long siteFriendlyURLId) Returns the site friendly url with the primary key.static SiteFriendlyURLgetSiteFriendlyURLByUuidAndGroupId(String uuid, long groupId) Returns the site friendly url matching the UUID and group.static List<SiteFriendlyURL> getSiteFriendlyURLs(int start, int end) Returns a range of all the site friendly urls.static List<SiteFriendlyURL> getSiteFriendlyURLs(long companyId, long groupId) static List<SiteFriendlyURL> getSiteFriendlyURLsByUuidAndCompanyId(String uuid, long companyId) Returns all the site friendly urls matching the UUID and company.static List<SiteFriendlyURL> getSiteFriendlyURLsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SiteFriendlyURL> orderByComparator) Returns a range of site friendly urls matching the UUID and company.static intReturns the number of site friendly urls.static SiteFriendlyURLupdateSiteFriendlyURL(long userId, long companyId, long groupId, String friendlyURL, String languageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static SiteFriendlyURLupdateSiteFriendlyURL(SiteFriendlyURL siteFriendlyURL) Updates the site friendly url in the database or adds it if it does not yet exist.static List<SiteFriendlyURL> updateSiteFriendlyURLs(long userId, long companyId, long groupId, Map<Locale, String> friendlyURLMap, com.liferay.portal.kernel.service.ServiceContext serviceContext)
-
Constructor Details
-
SiteFriendlyURLLocalServiceUtil
public SiteFriendlyURLLocalServiceUtil()
-
-
Method Details
-
addSiteFriendlyURL
public static SiteFriendlyURL addSiteFriendlyURL(long userId, long companyId, long groupId, String friendlyURL, String languageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addSiteFriendlyURL
Adds the site friendly url to the database. Also notifies the appropriate model listeners.Important: Inspect SiteFriendlyURLLocalServiceImpl 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:
siteFriendlyURL- the site friendly url- Returns:
- the site friendly url that was added
-
addSiteFriendlyURLs
public static List<SiteFriendlyURL> addSiteFriendlyURLs(long userId, long companyId, long groupId, Map<Locale, String> friendlyURLMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createSiteFriendlyURL
Creates a new site friendly url with the primary key. Does not add the site friendly url to the database.- Parameters:
siteFriendlyURLId- the primary key for the new site friendly url- Returns:
- the new site friendly url
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSiteFriendlyURL
public static SiteFriendlyURL deleteSiteFriendlyURL(long siteFriendlyURLId) throws com.liferay.portal.kernel.exception.PortalException Deletes the site friendly url with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect SiteFriendlyURLLocalServiceImpl 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:
siteFriendlyURLId- the primary key of the site friendly url- Returns:
- the site friendly url that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a site friendly url with the primary key could not be found
-
deleteSiteFriendlyURL
public static SiteFriendlyURL deleteSiteFriendlyURL(long companyId, long groupId, String languageId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSiteFriendlyURL
Deletes the site friendly url from the database. Also notifies the appropriate model listeners.Important: Inspect SiteFriendlyURLLocalServiceImpl 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:
siteFriendlyURL- the site friendly url- Returns:
- the site friendly url that was removed
-
deleteSiteFriendlyURLs
public static void deleteSiteFriendlyURLs(long companyId, long groupId) -
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
public static com.liferay.portal.kernel.dao.orm.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
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 - 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.site.model.impl.SiteFriendlyURLModelImpl.- 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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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.site.model.impl.SiteFriendlyURLModelImpl.- 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
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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
-
fetchSiteFriendlyURL
-
fetchSiteFriendlyURL
-
fetchSiteFriendlyURLByFriendlyURL
-
fetchSiteFriendlyURLByUuidAndGroupId
Returns the site friendly url matching the UUID and group.- Parameters:
uuid- the site friendly url's UUIDgroupId- the primary key of the group- Returns:
- the matching site friendly url, or
nullif a matching site friendly url could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getSiteFriendlyURL
public static SiteFriendlyURL getSiteFriendlyURL(long siteFriendlyURLId) throws com.liferay.portal.kernel.exception.PortalException Returns the site friendly url with the primary key.- Parameters:
siteFriendlyURLId- the primary key of the site friendly url- Returns:
- the site friendly url
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a site friendly url with the primary key could not be found
-
getSiteFriendlyURLByUuidAndGroupId
public static SiteFriendlyURL getSiteFriendlyURLByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the site friendly url matching the UUID and group.- Parameters:
uuid- the site friendly url's UUIDgroupId- the primary key of the group- Returns:
- the matching site friendly url
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a matching site friendly url could not be found
-
getSiteFriendlyURLs
Returns a range of all the site 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.site.model.impl.SiteFriendlyURLModelImpl.- Parameters:
start- the lower bound of the range of site friendly urlsend- the upper bound of the range of site friendly urls (not inclusive)- Returns:
- the range of site friendly urls
-
getSiteFriendlyURLs
-
getSiteFriendlyURLsByUuidAndCompanyId
public static List<SiteFriendlyURL> getSiteFriendlyURLsByUuidAndCompanyId(String uuid, long companyId) Returns all the site friendly urls matching the UUID and company.- Parameters:
uuid- the UUID of the site friendly urlscompanyId- the primary key of the company- Returns:
- the matching site friendly urls, or an empty list if no matches were found
-
getSiteFriendlyURLsByUuidAndCompanyId
public static List<SiteFriendlyURL> getSiteFriendlyURLsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SiteFriendlyURL> orderByComparator) Returns a range of site friendly urls matching the UUID and company.- Parameters:
uuid- the UUID of the site friendly urlscompanyId- the primary key of the companystart- the lower bound of the range of site friendly urlsend- the upper bound of the range of site friendly urls (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the range of matching site friendly urls, or an empty list if no matches were found
-
getSiteFriendlyURLsCount
public static int getSiteFriendlyURLsCount()Returns the number of site friendly urls.- Returns:
- the number of site friendly urls
-
updateSiteFriendlyURL
public static SiteFriendlyURL updateSiteFriendlyURL(long userId, long companyId, long groupId, String friendlyURL, String languageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateSiteFriendlyURL
Updates the site friendly url in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect SiteFriendlyURLLocalServiceImpl 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:
siteFriendlyURL- the site friendly url- Returns:
- the site friendly url that was updated
-
updateSiteFriendlyURLs
public static List<SiteFriendlyURL> updateSiteFriendlyURLs(long userId, long companyId, long groupId, Map<Locale, String> friendlyURLMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-