Class LayoutPageTemplateCollectionLocalServiceUtil

java.lang.Object
com.liferay.layout.page.template.service.LayoutPageTemplateCollectionLocalServiceUtil

public class LayoutPageTemplateCollectionLocalServiceUtil extends Object
Provides the local service utility for LayoutPageTemplateCollection. This utility wraps com.liferay.layout.page.template.service.impl.LayoutPageTemplateCollectionLocalServiceImpl 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 Details

    • LayoutPageTemplateCollectionLocalServiceUtil

      public LayoutPageTemplateCollectionLocalServiceUtil()
  • Method Details

    • addLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection addLayoutPageTemplateCollection(LayoutPageTemplateCollection layoutPageTemplateCollection)
      Adds the layout page template collection to the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPageTemplateCollectionLocalServiceImpl 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:
      layoutPageTemplateCollection - the layout page template collection
      Returns:
      the layout page template collection that was added
    • addLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection addLayoutPageTemplateCollection(String externalReferenceCode, long userId, long groupId, long parentLayoutPageTemplateCollectionId, String layoutPageTemplateCollectionKey, String name, String description, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection copyLayoutPageTemplateCollection(long userId, long groupId, long sourceLayoutPageTemplateCollectionId, long layoutParentPageTemplateCollectionId, boolean copyPermissions, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws Exception
      Throws:
      Exception
    • createLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection createLayoutPageTemplateCollection(long layoutPageTemplateCollectionId)
      Creates a new layout page template collection with the primary key. Does not add the layout page template collection to the database.
      Parameters:
      layoutPageTemplateCollectionId - the primary key for the new layout page template collection
      Returns:
      the new layout page template collection
    • 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
    • deleteLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection deleteLayoutPageTemplateCollection(LayoutPageTemplateCollection layoutPageTemplateCollection) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the layout page template collection from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPageTemplateCollectionLocalServiceImpl 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:
      layoutPageTemplateCollection - the layout page template collection
      Returns:
      the layout page template collection that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection deleteLayoutPageTemplateCollection(long layoutPageTemplateCollectionId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the layout page template collection with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPageTemplateCollectionLocalServiceImpl 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:
      layoutPageTemplateCollectionId - the primary key of the layout page template collection
      Returns:
      the layout page template collection that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a layout page template collection with the primary key could not be found
    • deleteLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection deleteLayoutPageTemplateCollection(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • 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

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 - 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.layout.page.template.model.impl.LayoutPageTemplateCollectionModelImpl.

      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(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 - 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.layout.page.template.model.impl.LayoutPageTemplateCollectionModelImpl.

      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(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 query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection fetchLayoutPageTemplateCollection(long layoutPageTemplateCollectionId)
    • fetchLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection fetchLayoutPageTemplateCollection(long groupId, String layoutPageTemplateCollectionKey, int type)
    • fetchLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection fetchLayoutPageTemplateCollection(long groupId, String name, long parentLayoutPageTemplateCollectionId, int type)
    • fetchLayoutPageTemplateCollectionByExternalReferenceCode

      public static LayoutPageTemplateCollection fetchLayoutPageTemplateCollectionByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchLayoutPageTemplateCollectionByUuidAndGroupId

      public static LayoutPageTemplateCollection fetchLayoutPageTemplateCollectionByUuidAndGroupId(String uuid, long groupId)
      Returns the layout page template collection matching the UUID and group.
      Parameters:
      uuid - the layout page template collection's UUID
      groupId - the primary key of the group
      Returns:
      the matching layout page template collection, or null if a matching layout page template collection 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()
    • getLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection getLayoutPageTemplateCollection(long layoutPageTemplateCollectionId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the layout page template collection with the primary key.
      Parameters:
      layoutPageTemplateCollectionId - the primary key of the layout page template collection
      Returns:
      the layout page template collection
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a layout page template collection with the primary key could not be found
    • getLayoutPageTemplateCollectionByExternalReferenceCode

      public static LayoutPageTemplateCollection getLayoutPageTemplateCollectionByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getLayoutPageTemplateCollectionByUuidAndGroupId

      public static LayoutPageTemplateCollection getLayoutPageTemplateCollectionByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the layout page template collection matching the UUID and group.
      Parameters:
      uuid - the layout page template collection's UUID
      groupId - the primary key of the group
      Returns:
      the matching layout page template collection
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching layout page template collection could not be found
    • getLayoutPageTemplateCollections

      public static List<LayoutPageTemplateCollection> getLayoutPageTemplateCollections(int start, int end)
      Returns a range of all the layout page template collections.

      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.layout.page.template.model.impl.LayoutPageTemplateCollectionModelImpl.

      Parameters:
      start - the lower bound of the range of layout page template collections
      end - the upper bound of the range of layout page template collections (not inclusive)
      Returns:
      the range of layout page template collections
    • getLayoutPageTemplateCollections

      public static List<LayoutPageTemplateCollection> getLayoutPageTemplateCollections(long groupId)
    • getLayoutPageTemplateCollections

      public static List<LayoutPageTemplateCollection> getLayoutPageTemplateCollections(long groupId, int type, int start, int end)
    • getLayoutPageTemplateCollections

      public static List<LayoutPageTemplateCollection> getLayoutPageTemplateCollections(long groupId, int type, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutPageTemplateCollection> orderByComparator)
    • getLayoutPageTemplateCollections

      public static List<LayoutPageTemplateCollection> getLayoutPageTemplateCollections(long groupId, long layoutPageTemplateCollectionId)
    • getLayoutPageTemplateCollections

      public static List<LayoutPageTemplateCollection> getLayoutPageTemplateCollections(long groupId, long layoutPageTemplateCollectionId, int type)
    • getLayoutPageTemplateCollections

      public static List<LayoutPageTemplateCollection> getLayoutPageTemplateCollections(long groupId, String name, int type, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutPageTemplateCollection> orderByComparator)
    • getLayoutPageTemplateCollectionsByUuidAndCompanyId

      public static List<LayoutPageTemplateCollection> getLayoutPageTemplateCollectionsByUuidAndCompanyId(String uuid, long companyId)
      Returns all the layout page template collections matching the UUID and company.
      Parameters:
      uuid - the UUID of the layout page template collections
      companyId - the primary key of the company
      Returns:
      the matching layout page template collections, or an empty list if no matches were found
    • getLayoutPageTemplateCollectionsByUuidAndCompanyId

      public static List<LayoutPageTemplateCollection> getLayoutPageTemplateCollectionsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutPageTemplateCollection> orderByComparator)
      Returns a range of layout page template collections matching the UUID and company.
      Parameters:
      uuid - the UUID of the layout page template collections
      companyId - the primary key of the company
      start - the lower bound of the range of layout page template collections
      end - the upper bound of the range of layout page template collections (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching layout page template collections, or an empty list if no matches were found
    • getLayoutPageTemplateCollectionsCount

      public static int getLayoutPageTemplateCollectionsCount()
      Returns the number of layout page template collections.
      Returns:
      the number of layout page template collections
    • getLayoutPageTemplateCollectionsCount

      public static int getLayoutPageTemplateCollectionsCount(long groupId, int type)
    • getLayoutPageTemplateCollectionsCount

      public static int getLayoutPageTemplateCollectionsCount(long groupId, String name, int type)
    • getOSGiServiceIdentifier

      public static String 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
    • getUniqueLayoutPageTemplateCollectionName

      public static String getUniqueLayoutPageTemplateCollectionName(long groupId, long layoutPageTemplateCollectionId, String sourceName, int type)
    • moveLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection moveLayoutPageTemplateCollection(long layoutPageTemplateCollectionId, long parentLayoutPageTemplateCollectionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection updateLayoutPageTemplateCollection(LayoutPageTemplateCollection layoutPageTemplateCollection)
      Updates the layout page template collection in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPageTemplateCollectionLocalServiceImpl 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:
      layoutPageTemplateCollection - the layout page template collection
      Returns:
      the layout page template collection that was updated
    • updateLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection updateLayoutPageTemplateCollection(long layoutPageTemplateCollectionId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutPageTemplateCollection

      public static LayoutPageTemplateCollection updateLayoutPageTemplateCollection(long layoutPageTemplateCollectionId, String name, String description) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static LayoutPageTemplateCollectionLocalService getService()