Liferay 7.0-ce-b4

com.liferay.portal.service
Class LayoutFriendlyURLLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.LayoutFriendlyURLLocalServiceUtil

@ProviderType
public class LayoutFriendlyURLLocalServiceUtil
extends Object

Provides the local service utility for LayoutFriendlyURL. This utility wraps LayoutFriendlyURLLocalServiceImpl and is the primary 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:
LayoutFriendlyURLLocalService, LayoutFriendlyURLLocalServiceBaseImpl, LayoutFriendlyURLLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
LayoutFriendlyURLLocalServiceUtil()
           
 
Method Summary
static LayoutFriendlyURL addLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
          Adds the layout friendly u r l to the database.
static LayoutFriendlyURL addLayoutFriendlyURL(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext)
           
static List<LayoutFriendlyURL> addLayoutFriendlyURLs(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext)
           
static LayoutFriendlyURL createLayoutFriendlyURL(long layoutFriendlyURLId)
          Creates a new layout friendly u r l with the primary key.
static LayoutFriendlyURL deleteLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
          Deletes the layout friendly u r l from the database.
static LayoutFriendlyURL deleteLayoutFriendlyURL(long layoutFriendlyURLId)
          Deletes the layout friendly u r l with the primary key from the database.
static void deleteLayoutFriendlyURL(long plid, String languageId)
           
static void deleteLayoutFriendlyURLs(long plid)
           
static PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static DynamicQuery dynamicQuery()
           
static
<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 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
static LayoutFriendlyURL fetchFirstLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL)
           
static LayoutFriendlyURL fetchLayoutFriendlyURL(long layoutFriendlyURLId)
           
static LayoutFriendlyURL fetchLayoutFriendlyURL(long groupId, boolean privateLayout, String friendlyURL, String languageId)
           
static LayoutFriendlyURL fetchLayoutFriendlyURL(long plid, String languageId)
           
static LayoutFriendlyURL fetchLayoutFriendlyURL(long plid, String languageId, boolean useDefault)
           
static LayoutFriendlyURL fetchLayoutFriendlyURLByUuidAndGroupId(String uuid, long groupId)
          Returns the layout friendly u r l matching the UUID and group.
static ActionableDynamicQuery getActionableDynamicQuery()
           
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
static LayoutFriendlyURL getLayoutFriendlyURL(long layoutFriendlyURLId)
          Returns the layout friendly u r l with the primary key.
static LayoutFriendlyURL getLayoutFriendlyURL(long plid, String languageId)
           
static LayoutFriendlyURL getLayoutFriendlyURL(long plid, String languageId, boolean useDefault)
           
static LayoutFriendlyURL getLayoutFriendlyURLByUuidAndGroupId(String uuid, long groupId)
          Returns the layout friendly u r l matching the UUID and group.
static List<LayoutFriendlyURL> getLayoutFriendlyURLs(int start, int end)
          Returns a range of all the layout friendly u r ls.
static List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid)
           
static List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid, String friendlyURL, int start, int end)
           
static List<LayoutFriendlyURL> getLayoutFriendlyURLsByUuidAndCompanyId(String uuid, long companyId)
          Returns all the layout friendly u r ls 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 u r ls matching the UUID and company.
static int getLayoutFriendlyURLsCount()
          Returns the number of layout friendly u r ls.
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static LayoutFriendlyURLLocalService getService()
           
static LayoutFriendlyURL updateLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
          Updates the layout friendly u r l in the database or adds it if it does not yet exist.
static LayoutFriendlyURL updateLayoutFriendlyURL(long userId, long companyId, long groupId, long plid, boolean privateLayout, String friendlyURL, String languageId, ServiceContext serviceContext)
           
static List<LayoutFriendlyURL> updateLayoutFriendlyURLs(long userId, long companyId, long groupId, long plid, boolean privateLayout, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LayoutFriendlyURLLocalServiceUtil

public LayoutFriendlyURLLocalServiceUtil()
Method Detail

addLayoutFriendlyURL

public static LayoutFriendlyURL addLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
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

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

public static 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

public static LayoutFriendlyURL deleteLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
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

deleteLayoutFriendlyURL

public static LayoutFriendlyURL deleteLayoutFriendlyURL(long layoutFriendlyURLId)
                                                 throws PortalException
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

deleteLayoutFriendlyURL

public static void deleteLayoutFriendlyURL(long plid,
                                           String languageId)

deleteLayoutFriendlyURLs

public static void deleteLayoutFriendlyURLs(long plid)

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public 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.

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

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

public static 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

public static 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

public static LayoutFriendlyURL fetchFirstLayoutFriendlyURL(long groupId,
                                                            boolean privateLayout,
                                                            String friendlyURL)

fetchLayoutFriendlyURL

public static LayoutFriendlyURL fetchLayoutFriendlyURL(long groupId,
                                                       boolean privateLayout,
                                                       String friendlyURL,
                                                       String languageId)

fetchLayoutFriendlyURL

public static LayoutFriendlyURL fetchLayoutFriendlyURL(long layoutFriendlyURLId)

fetchLayoutFriendlyURL

public static LayoutFriendlyURL fetchLayoutFriendlyURL(long plid,
                                                       String languageId)

fetchLayoutFriendlyURL

public static LayoutFriendlyURL fetchLayoutFriendlyURL(long plid,
                                                       String languageId,
                                                       boolean useDefault)

fetchLayoutFriendlyURLByUuidAndGroupId

public static LayoutFriendlyURL fetchLayoutFriendlyURLByUuidAndGroupId(String uuid,
                                                                       long groupId)
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

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayoutFriendlyURL

public static LayoutFriendlyURL getLayoutFriendlyURL(long layoutFriendlyURLId)
                                              throws PortalException
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

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

getLayoutFriendlyURLs

public static List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid)

getLayoutFriendlyURLs

public static List<LayoutFriendlyURL> getLayoutFriendlyURLs(long plid,
                                                            String friendlyURL,
                                                            int start,
                                                            int end)

getLayoutFriendlyURLs

public static List<LayoutFriendlyURL> getLayoutFriendlyURLs(int start,
                                                            int end)
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

getLayoutFriendlyURLsByUuidAndCompanyId

public static List<LayoutFriendlyURL> getLayoutFriendlyURLsByUuidAndCompanyId(String uuid,
                                                                              long companyId)
Returns all the layout friendly u r ls matching the UUID and company.

Parameters:
uuid - the UUID of the layout friendly u r ls
companyId - the primary key of the company
Returns:
the matching layout friendly u r ls, 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 u r ls matching the UUID and company.

Parameters:
uuid - the UUID of the layout friendly u r ls
companyId - the primary key of the company
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)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the range of matching layout friendly u r ls, or an empty list if no matches were found

getLayoutFriendlyURLsCount

public static int getLayoutFriendlyURLsCount()
Returns the number of layout friendly u r ls.

Returns:
the number of layout friendly u r ls

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

updateLayoutFriendlyURL

public static LayoutFriendlyURL updateLayoutFriendlyURL(LayoutFriendlyURL layoutFriendlyURL)
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

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

public static LayoutFriendlyURLLocalService getService()

Liferay 7.0-ce-b4