Class LayoutSetPrototypeLocalServiceUtil

Object
com.liferay.portal.kernel.service.LayoutSetPrototypeLocalServiceUtil

public class LayoutSetPrototypeLocalServiceUtil extends Object
Provides the local service utility for LayoutSetPrototype. This utility wraps com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl 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

    • LayoutSetPrototypeLocalServiceUtil

      public LayoutSetPrototypeLocalServiceUtil()
  • Method Details

    • addLayoutSetPrototype

      public static LayoutSetPrototype addLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
      Adds the layout set prototype to the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSetPrototypeLocalServiceImpl 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:
      layoutSetPrototype - the layout set prototype
      Returns:
      the layout set prototype that was added
    • addLayoutSetPrototype

      public static LayoutSetPrototype addLayoutSetPrototype(long userId, long companyId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, boolean layoutsUpdateable, boolean readyForPropagation, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • addLayoutSetPrototype

      public static LayoutSetPrototype addLayoutSetPrototype(long userId, long companyId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • createLayoutSetPrototype

      public static LayoutSetPrototype createLayoutSetPrototype(long layoutSetPrototypeId)
      Creates a new layout set prototype with the primary key. Does not add the layout set prototype to the database.
      Parameters:
      layoutSetPrototypeId - the primary key for the new layout set prototype
      Returns:
      the new layout set prototype
    • createPersistedModel

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

      public static LayoutSetPrototype deleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) throws PortalException
      Deletes the layout set prototype from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSetPrototypeLocalServiceImpl 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:
      layoutSetPrototype - the layout set prototype
      Returns:
      the layout set prototype that was removed
      Throws:
      PortalException
    • deleteLayoutSetPrototype

      public static LayoutSetPrototype deleteLayoutSetPrototype(long layoutSetPrototypeId) throws PortalException
      Deletes the layout set prototype with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static void deleteLayoutSetPrototypes() throws PortalException
      Throws:
      PortalException
    • deleteNondefaultLayoutSetPrototypes

      public static void deleteNondefaultLayoutSetPrototypes(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.LayoutSetPrototypeModelImpl.

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

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

      public static LayoutSetPrototype fetchLayoutSetPrototype(long layoutSetPrototypeId)
    • fetchLayoutSetPrototypeByUuidAndCompanyId

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

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getLayoutSetPrototype

      public static LayoutSetPrototype getLayoutSetPrototype(long layoutSetPrototypeId) throws PortalException
      Returns the layout set prototype with the primary key.
      Parameters:
      layoutSetPrototypeId - the primary key of the layout set prototype
      Returns:
      the layout set prototype
      Throws:
      PortalException - if a layout set prototype with the primary key could not be found
    • getLayoutSetPrototypeByUuidAndCompanyId

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

      public static List<LayoutSetPrototype> getLayoutSetPrototypes(int start, int end)
      Returns a range of all the layout set 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.LayoutSetPrototypeModelImpl.

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

      public static List<LayoutSetPrototype> getLayoutSetPrototypes(long companyId)
    • getLayoutSetPrototypesCount

      public static int getLayoutSetPrototypesCount()
      Returns the number of layout set prototypes.
      Returns:
      the number of layout set 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<LayoutSetPrototype> search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutSetPrototype> orderByComparator)
    • searchCount

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

      public static LayoutSetPrototype updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
      Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSetPrototypeLocalServiceImpl 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:
      layoutSetPrototype - the layout set prototype
      Returns:
      the layout set prototype that was updated
    • updateLayoutSetPrototype

      public static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, boolean layoutsUpdateable, boolean readyForPropagation, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • updateLayoutSetPrototype

      public static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • updateLayoutSetPrototype

      public static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, String settings) throws PortalException
      Throws:
      PortalException
    • getService

      public static LayoutSetPrototypeLocalService getService()
    • setService

      public static void setService(LayoutSetPrototypeLocalService service)