Class LayoutBranchLocalServiceUtil

Object
com.liferay.portal.kernel.service.LayoutBranchLocalServiceUtil

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

    • LayoutBranchLocalServiceUtil

      public LayoutBranchLocalServiceUtil()
  • Method Details

    • addLayoutBranch

      public static LayoutBranch addLayoutBranch(LayoutBranch layoutBranch)
      Adds the layout branch to the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutBranchLocalServiceImpl 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:
      layoutBranch - the layout branch
      Returns:
      the layout branch that was added
    • addLayoutBranch

      public static LayoutBranch addLayoutBranch(long layoutSetBranchId, long plid, String name, String description, boolean master, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • addLayoutBranch

      public static LayoutBranch addLayoutBranch(long layoutRevisionId, String name, String description, boolean master, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • createLayoutBranch

      public static LayoutBranch createLayoutBranch(long layoutBranchId)
      Creates a new layout branch with the primary key. Does not add the layout branch to the database.
      Parameters:
      layoutBranchId - the primary key for the new layout branch
      Returns:
      the new layout branch
    • createPersistedModel

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

      public static LayoutBranch deleteLayoutBranch(LayoutBranch layoutBranch)
      Deletes the layout branch from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutBranchLocalServiceImpl 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:
      layoutBranch - the layout branch
      Returns:
      the layout branch that was removed
    • deleteLayoutBranch

      public static LayoutBranch deleteLayoutBranch(long layoutBranchId) throws PortalException
      Deletes the layout branch with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutBranchLocalServiceImpl 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:
      layoutBranchId - the primary key of the layout branch
      Returns:
      the layout branch that was removed
      Throws:
      PortalException - if a layout branch with the primary key could not be found
    • deleteLayoutBranchesByPlid

      public static void deleteLayoutBranchesByPlid(long plid) throws PortalException
      Throws:
      PortalException
    • deleteLayoutSetBranchLayoutBranches

      public static void deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId) 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.LayoutBranchModelImpl.

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

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

      public static LayoutBranch fetchLayoutBranch(long layoutBranchId)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getLayoutBranch

      public static LayoutBranch getLayoutBranch(long layoutBranchId) throws PortalException
      Returns the layout branch with the primary key.
      Parameters:
      layoutBranchId - the primary key of the layout branch
      Returns:
      the layout branch
      Throws:
      PortalException - if a layout branch with the primary key could not be found
    • getLayoutBranches

      public static List<LayoutBranch> getLayoutBranches(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutBranch> orderByComparator)
    • getLayoutBranchs

      public static List<LayoutBranch> getLayoutBranchs(int start, int end)
      Returns a range of all the layout branches.

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

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

      public static int getLayoutBranchsCount()
      Returns the number of layout branches.
      Returns:
      the number of layout branches
    • getLayoutSetBranchLayoutBranches

      public static List<LayoutBranch> getLayoutSetBranchLayoutBranches(long layoutSetBranchId)
    • getMasterLayoutBranch

      public static LayoutBranch getMasterLayoutBranch(long layoutSetBranchId, long plid) throws PortalException
      Throws:
      PortalException
    • getMasterLayoutBranch

      public static LayoutBranch getMasterLayoutBranch(long layoutSetBranchId, long plid, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • 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
    • updateLayoutBranch

      public static LayoutBranch updateLayoutBranch(LayoutBranch layoutBranch)
      Updates the layout branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect LayoutBranchLocalServiceImpl 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:
      layoutBranch - the layout branch
      Returns:
      the layout branch that was updated
    • updateLayoutBranch

      public static LayoutBranch updateLayoutBranch(long layoutBranchId, String name, String description, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • getService

      public static LayoutBranchLocalService getService()
    • setService

      public static void setService(LayoutBranchLocalService service)