Class LayoutPrototypeLocalServiceUtil

Object
com.liferay.portal.kernel.service.LayoutPrototypeLocalServiceUtil

public class LayoutPrototypeLocalServiceUtil extends Object
Provides the local service utility for LayoutPrototype. This utility wraps com.liferay.portal.service.impl.LayoutPrototypeLocalServiceImpl 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.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • LayoutPrototypeLocalServiceUtil

      public LayoutPrototypeLocalServiceUtil()
  • Method Details

    • addLayoutPrototype

      public static LayoutPrototype addLayoutPrototype(LayoutPrototype layoutPrototype)
      Adds the layout prototype to the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPrototypeLocalServiceImpl 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:
      layoutPrototype - the layout prototype
      Returns:
      the layout prototype that was added
    • addLayoutPrototype

      public static LayoutPrototype addLayoutPrototype(long userId, long companyId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • createLayoutPrototype

      public static LayoutPrototype createLayoutPrototype(long layoutPrototypeId)
      Creates a new layout prototype with the primary key. Does not add the layout prototype to the database.
      Parameters:
      layoutPrototypeId - the primary key for the new layout prototype
      Returns:
      the new layout prototype
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • deleteLayoutPrototype

      public static LayoutPrototype deleteLayoutPrototype(LayoutPrototype layoutPrototype) throws PortalException
      Deletes the layout prototype from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPrototypeLocalServiceImpl 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:
      layoutPrototype - the layout prototype
      Returns:
      the layout prototype that was removed
      Throws:
      PortalException
    • deleteLayoutPrototype

      public static LayoutPrototype deleteLayoutPrototype(long layoutPrototypeId) throws PortalException
      Deletes the layout prototype with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPrototypeLocalServiceImpl 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:
      layoutPrototypeId - the primary key of the layout prototype
      Returns:
      the layout prototype that was removed
      Throws:
      PortalException - if a layout prototype with the primary key could not be found
    • deleteNondefaultLayoutPrototypes

      public static void deleteNondefaultLayoutPrototypes(long companyId) throws PortalException
      Throws:
      PortalException
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      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 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 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.portal.model.impl.LayoutPrototypeModelImpl.

      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 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.portal.model.impl.LayoutPrototypeModelImpl.

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

      public static LayoutPrototype fetchLayoutPrototype(long layoutPrototypeId)
    • fetchLayoutPrototype

      public static LayoutPrototype fetchLayoutPrototype(long companyId, String name, Locale locale)
    • fetchLayoutPrototypeByUuidAndCompanyId

      public static LayoutPrototype fetchLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId)
      Returns the layout prototype with the matching UUID and company.
      Parameters:
      uuid - the layout prototype's UUID
      companyId - the primary key of the company
      Returns:
      the matching layout prototype, or null if a matching layout prototype could not be found
    • fetchLayoutProtoype

      public static LayoutPrototype fetchLayoutProtoype(long companyId, String name)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getLayoutPrototype

      public static LayoutPrototype getLayoutPrototype(long layoutPrototypeId) throws PortalException
      Returns the layout prototype with the primary key.
      Parameters:
      layoutPrototypeId - the primary key of the layout prototype
      Returns:
      the layout prototype
      Throws:
      PortalException - if a layout prototype with the primary key could not be found
    • getLayoutPrototype

      public static LayoutPrototype getLayoutPrototype(long companyId, String name) throws PortalException
      Throws:
      PortalException
    • getLayoutPrototype

      public static LayoutPrototype getLayoutPrototype(long companyId, String name, Locale locale) throws PortalException
      Throws:
      PortalException
    • getLayoutPrototypeByUuidAndCompanyId

      public static LayoutPrototype getLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId) throws PortalException
      Returns the layout prototype with the matching UUID and company.
      Parameters:
      uuid - the layout prototype's UUID
      companyId - the primary key of the company
      Returns:
      the matching layout prototype
      Throws:
      PortalException - if a matching layout prototype could not be found
    • getLayoutPrototypes

      public static List<LayoutPrototype> getLayoutPrototypes(int start, int end)
      Returns a range of all the layout prototypes.

      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.portal.model.impl.LayoutPrototypeModelImpl.

      Parameters:
      start - the lower bound of the range of layout prototypes
      end - the upper bound of the range of layout prototypes (not inclusive)
      Returns:
      the range of layout prototypes
    • getLayoutPrototypesCount

      public static int getLayoutPrototypesCount()
      Returns the number of layout prototypes.
      Returns:
      the number of layout prototypes
    • 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
    • search

      public static List<LayoutPrototype> search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutPrototype> orderByComparator)
    • searchCount

      public static int searchCount(long companyId, Boolean active)
    • updateLayoutPrototype

      public static LayoutPrototype updateLayoutPrototype(LayoutPrototype layoutPrototype)
      Updates the layout prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPrototypeLocalServiceImpl 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:
      layoutPrototype - the layout prototype
      Returns:
      the layout prototype that was updated
    • updateLayoutPrototype

      public static LayoutPrototype updateLayoutPrototype(long layoutPrototypeId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • getService

      public static LayoutPrototypeLocalService getService()
    • setService

      public static void setService(LayoutPrototypeLocalService service)