com.liferay.portal.kernel.service

Interface LayoutFriendlyURLLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

LayoutFriendlyURLLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface LayoutFriendlyURLLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for LayoutFriendlyURL. 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:

LayoutFriendlyURLLocalServiceUtil, LayoutFriendlyURLLocalServiceBaseImpl, LayoutFriendlyURLLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
LayoutFriendlyURL	addLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL) Adds the layout friendly url to the database.
LayoutFriendlyURL	addLayoutFriendlyURL(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext)
List<LayoutFriendlyURL>	addLayoutFriendlyURLs(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext)
LayoutFriendlyURL	createLayoutFriendlyURL(long layoutFriendlyURLId) Creates a new layout friendly url with the primary key.
LayoutFriendlyURL	deleteLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL) Deletes the layout friendly url from the database.
LayoutFriendlyURL	deleteLayoutFriendlyURL(long layoutFriendlyURLId) Deletes the layout friendly url with the primary key from the database.
void	deleteLayoutFriendlyURL(long plid, String languageId)
void	deleteLayoutFriendlyURLs(long plid)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<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.
LayoutFriendlyURL	fetchFirstLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL)
LayoutFriendlyURL	fetchLayoutFriendlyURL(long layoutFriendlyURLId)
LayoutFriendlyURL	fetchLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL, String languageId)
LayoutFriendlyURL	fetchLayoutFriendlyURL(long plid, String languageId)
LayoutFriendlyURL	fetchLayoutFriendlyURL(long plid, String languageId, boolean useDefault)
LayoutFriendlyURL	fetchLayoutFriendlyURLByUuidAndGroupId(String uuid, long groupId) Returns the layout friendly url matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
LayoutFriendlyURL	getLayoutFriendlyURL(long layoutFriendlyURLId) Returns the layout friendly url with the primary key.
LayoutFriendlyURL	getLayoutFriendlyURL(long plid, String languageId)
LayoutFriendlyURL	getLayoutFriendlyURL(long plid, String languageId, boolean useDefault)
LayoutFriendlyURL	getLayoutFriendlyURLByUuidAndGroupId(String uuid, long groupId) Returns the layout friendly url matching the UUID and group.
Map<Long,String>	getLayoutFriendlyURLs(Group siteGroup, List<Layout> layouts, String languageId)
List<LayoutFriendlyURL>	getLayoutFriendlyURLs(int start, int end) Returns a range of all the layout friendly urls.
List<LayoutFriendlyURL>	getLayoutFriendlyURLs(long plid)
List<LayoutFriendlyURL>	getLayoutFriendlyURLs(long plid, String friendlyURL, int start, int end)
List<LayoutFriendlyURL>	getLayoutFriendlyURLsByUuidAndCompanyId(String uuid, long companyId) Returns all the layout friendly urls matching the UUID and company.
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.
int	getLayoutFriendlyURLsCount() Returns the number of layout friendly urls.
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
LayoutFriendlyURL	updateLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL) Updates the layout friendly url in the database or adds it if it does not yet exist.
LayoutFriendlyURL	updateLayoutFriendlyURL(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext)
List<LayoutFriendlyURL>	updateLayoutFriendlyURLs(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext)

Method Detail

addLayoutFriendlyURL

@Indexable(type=REINDEX)
LayoutFriendlyURL addLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)

Adds the layout friendly url to the database. Also notifies the appropriate model listeners.

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

@Transactional(enabled=false)
LayoutFriendlyURL createLayoutFriendlyURL(long layoutFriendlyURLId)

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

deleteLayoutFriendlyURL

@Indexable(type=DELETE)
LayoutFriendlyURL deleteLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)

Deletes the layout friendly url from the database. Also notifies the appropriate model listeners.

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.

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

void deleteLayoutFriendlyURL(long plid,
                             String languageId)

deleteLayoutFriendlyURLs

void deleteLayoutFriendlyURLs(long plid)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery 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 and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutFriendlyURLModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - 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 and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutFriendlyURLModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

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 query

projection - 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 UUID

groupId - 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 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 UUID

groupId - 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<Long,String> getLayoutFriendlyURLs(Group siteGroup,
                                                                                                          List<Layout> layouts,
                                                                                                          String languageId)

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 and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutFriendlyURLModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of layout friendly urls

end - 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 urls

companyId - 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 urls

companyId - the primary key of the company

start - the lower bound of the range of layout friendly urls

end - the upper bound of the range of layout friendly urls (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching layout friendly urls, or an empty list if no matches were found

getLayoutFriendlyURLsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutFriendlyURLsCount()

Returns the number of layout friendly urls.

Returns:

the number of layout friendly urls

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 interface PersistedModelLocalService

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.

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