Liferay 6.2-ce-ga5

com.liferay.portal.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.

See Also:
LayoutFriendlyURLLocalServiceUtil, LayoutFriendlyURLLocalServiceBaseImpl, com.liferay.portal.service.impl.LayoutFriendlyURLLocalServiceImpl

Method Summary
 LayoutFriendlyURL addLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
          Adds the layout friendly u r l 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 u r l with the primary key.
 LayoutFriendlyURL deleteLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
          Deletes the layout friendly u r l from the database.
 LayoutFriendlyURL deleteLayoutFriendlyURL(long layoutFriendlyURLId)
          Deletes the layout friendly u r l with the primary key from the database.
 void deleteLayoutFriendlyURL(long plid, String languageId)
           
 void deleteLayoutFriendlyURLs(long plid)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match 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 fetchLayoutFriendlyURLByUuidAndCompanyId(String uuid, long companyId)
          Returns the layout friendly u r l with the matching UUID and company.
 LayoutFriendlyURL fetchLayoutFriendlyURLByUuidAndGroupId(String uuid, long groupId)
          Returns the layout friendly u r l matching the UUID and group.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 LayoutFriendlyURL getLayoutFriendlyURL(long layoutFriendlyURLId)
          Returns the layout friendly u r l with the primary key.
 LayoutFriendlyURL getLayoutFriendlyURL(long plid, String languageId)
           
 LayoutFriendlyURL getLayoutFriendlyURL(long plid, String languageId, boolean useDefault)
           
 LayoutFriendlyURL getLayoutFriendlyURLByUuidAndCompanyId(String uuid, long companyId)
          Returns the layout friendly u r l with the matching UUID and company.
 LayoutFriendlyURL getLayoutFriendlyURLByUuidAndGroupId(String uuid, long groupId)
          Returns the layout friendly u r l matching the UUID and group.
 List<LayoutFriendlyURL> getLayoutFriendlyURLs(int start, int end)
          Returns a range of all the layout friendly u r ls.
 List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid)
           
 List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid, String friendlyURL, int start, int end)
           
 int getLayoutFriendlyURLsCount()
          Returns the number of layout friendly u r ls.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 LayoutFriendlyURL updateLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
          Updates the layout friendly u r l 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)
                                       throws SystemException
Adds the layout friendly u r l to the database. Also notifies the appropriate model listeners.

Parameters:
layoutFriendlyURL - the layout friendly u r l
Returns:
the layout friendly u r l that was added
Throws:
SystemException - if a system exception occurred

createLayoutFriendlyURL

LayoutFriendlyURL createLayoutFriendlyURL(long layoutFriendlyURLId)
Creates a new layout friendly u r l with the primary key. Does not add the layout friendly u r l to the database.

Parameters:
layoutFriendlyURLId - the primary key for the new layout friendly u r l
Returns:
the new layout friendly u r l

deleteLayoutFriendlyURL

@Indexable(type=DELETE)
LayoutFriendlyURL deleteLayoutFriendlyURL(long layoutFriendlyURLId)
                                          throws PortalException,
                                                 SystemException
Deletes the layout friendly u r l with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
layoutFriendlyURLId - the primary key of the layout friendly u r l
Returns:
the layout friendly u r l that was removed
Throws:
PortalException - if a layout friendly u r l with the primary key could not be found
SystemException - if a system exception occurred

deleteLayoutFriendlyURL

@Indexable(type=DELETE)
LayoutFriendlyURL deleteLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
                                          throws SystemException
Deletes the layout friendly u r l from the database. Also notifies the appropriate model listeners.

Parameters:
layoutFriendlyURL - the layout friendly u r l
Returns:
the layout friendly u r l that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchLayoutFriendlyURL

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL fetchLayoutFriendlyURL(long layoutFriendlyURLId)
                                         throws SystemException
Throws:
SystemException

fetchLayoutFriendlyURLByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL fetchLayoutFriendlyURLByUuidAndCompanyId(String uuid,
                                                                                                    long companyId)
                                                           throws SystemException
Returns the layout friendly u r l with the matching UUID and company.

Parameters:
uuid - the layout friendly u r l's UUID
companyId - the primary key of the company
Returns:
the matching layout friendly u r l, or null if a matching layout friendly u r l could not be found
Throws:
SystemException - if a system exception occurred

fetchLayoutFriendlyURLByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL fetchLayoutFriendlyURLByUuidAndGroupId(String uuid,
                                                                                                  long groupId)
                                                         throws SystemException
Returns the layout friendly u r l matching the UUID and group.

Parameters:
uuid - the layout friendly u r l's UUID
groupId - the primary key of the group
Returns:
the matching layout friendly u r l, or null if a matching layout friendly u r l could not be found
Throws:
SystemException - if a system exception occurred

getLayoutFriendlyURL

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL getLayoutFriendlyURL(long layoutFriendlyURLId)
                                       throws PortalException,
                                              SystemException
Returns the layout friendly u r l with the primary key.

Parameters:
layoutFriendlyURLId - the primary key of the layout friendly u r l
Returns:
the layout friendly u r l
Throws:
PortalException - if a layout friendly u r l with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getLayoutFriendlyURLByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL getLayoutFriendlyURLByUuidAndCompanyId(String uuid,
                                                                                                  long companyId)
                                                         throws PortalException,
                                                                SystemException
Returns the layout friendly u r l with the matching UUID and company.

Parameters:
uuid - the layout friendly u r l's UUID
companyId - the primary key of the company
Returns:
the matching layout friendly u r l
Throws:
PortalException - if a matching layout friendly u r l could not be found
SystemException - if a system exception occurred

getLayoutFriendlyURLByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL getLayoutFriendlyURLByUuidAndGroupId(String uuid,
                                                                                                long groupId)
                                                       throws PortalException,
                                                              SystemException
Returns the layout friendly u r l matching the UUID and group.

Parameters:
uuid - the layout friendly u r l's UUID
groupId - the primary key of the group
Returns:
the matching layout friendly u r l
Throws:
PortalException - if a matching layout friendly u r l could not be found
SystemException - if a system exception occurred

getLayoutFriendlyURLs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutFriendlyURL> getLayoutFriendlyURLs(int start,
                                                                                       int end)
                                              throws SystemException
Returns a range of all the layout friendly u r ls.

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 u r ls
end - the upper bound of the range of layout friendly u r ls (not inclusive)
Returns:
the range of layout friendly u r ls
Throws:
SystemException - if a system exception occurred

getLayoutFriendlyURLsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutFriendlyURLsCount()
                               throws SystemException
Returns the number of layout friendly u r ls.

Returns:
the number of layout friendly u r ls
Throws:
SystemException - if a system exception occurred

updateLayoutFriendlyURL

@Indexable(type=REINDEX)
LayoutFriendlyURL updateLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
                                          throws SystemException
Updates the layout friendly u r l in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
layoutFriendlyURL - the layout friendly u r l
Returns:
the layout friendly u r l that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addLayoutFriendlyURL

LayoutFriendlyURL addLayoutFriendlyURL(long userId,
                                       long companyId,
                                       long groupId,
                                       long plid,
                                       boolean privateLayout,
                                       String friendlyURL,
                                       String languageId,
                                       ServiceContext serviceContext)
                                       throws PortalException,
                                              SystemException
Throws:
PortalException
SystemException

addLayoutFriendlyURLs

List<LayoutFriendlyURL> addLayoutFriendlyURLs(long userId,
                                              long companyId,
                                              long groupId,
                                              long plid,
                                              boolean privateLayout,
                                              Map<Locale,String> friendlyURLMap,
                                              ServiceContext serviceContext)
                                              throws PortalException,
                                                     SystemException
Throws:
PortalException
SystemException

deleteLayoutFriendlyURL

void deleteLayoutFriendlyURL(long plid,
                             String languageId)
                             throws SystemException
Throws:
SystemException

deleteLayoutFriendlyURLs

void deleteLayoutFriendlyURLs(long plid)
                              throws SystemException
Throws:
SystemException

fetchFirstLayoutFriendlyURL

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL fetchFirstLayoutFriendlyURL(long groupId,
                                                                                       boolean privateLayout,
                                                                                       String friendlyURL)
                                              throws SystemException
Throws:
SystemException

fetchLayoutFriendlyURL

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL fetchLayoutFriendlyURL(long groupId,
                                                                                  boolean privateLayout,
                                                                                  String friendlyURL,
                                                                                  String languageId)
                                         throws SystemException
Throws:
SystemException

fetchLayoutFriendlyURL

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL fetchLayoutFriendlyURL(long plid,
                                                                                  String languageId)
                                         throws SystemException
Throws:
SystemException

fetchLayoutFriendlyURL

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL fetchLayoutFriendlyURL(long plid,
                                                                                  String languageId,
                                                                                  boolean useDefault)
                                         throws SystemException
Throws:
SystemException

getLayoutFriendlyURL

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL getLayoutFriendlyURL(long plid,
                                                                                String languageId)
                                       throws PortalException,
                                              SystemException
Throws:
PortalException
SystemException

getLayoutFriendlyURL

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutFriendlyURL getLayoutFriendlyURL(long plid,
                                                                                String languageId,
                                                                                boolean useDefault)
                                       throws PortalException,
                                              SystemException
Throws:
PortalException
SystemException

getLayoutFriendlyURLs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid)
                                              throws SystemException
Throws:
SystemException

getLayoutFriendlyURLs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid,
                                                                                       String friendlyURL,
                                                                                       int start,
                                                                                       int end)
                                              throws SystemException
Throws:
SystemException

updateLayoutFriendlyURL

LayoutFriendlyURL updateLayoutFriendlyURL(long userId,
                                          long companyId,
                                          long groupId,
                                          long plid,
                                          boolean privateLayout,
                                          String friendlyURL,
                                          String languageId,
                                          ServiceContext serviceContext)
                                          throws PortalException,
                                                 SystemException
Throws:
PortalException
SystemException

updateLayoutFriendlyURLs

List<LayoutFriendlyURL> updateLayoutFriendlyURLs(long userId,
                                                 long companyId,
                                                 long groupId,
                                                 long plid,
                                                 boolean privateLayout,
                                                 Map<Locale,String> friendlyURLMap,
                                                 ServiceContext serviceContext)
                                                 throws PortalException,
                                                        SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5