Class FragmentCompositionLocalServiceUtil

java.lang.Object
com.liferay.fragment.service.FragmentCompositionLocalServiceUtil

public class FragmentCompositionLocalServiceUtil extends Object
Provides the local service utility for FragmentComposition. This utility wraps com.liferay.fragment.service.impl.FragmentCompositionLocalServiceImpl 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

    • FragmentCompositionLocalServiceUtil

      public FragmentCompositionLocalServiceUtil()
  • Method Details

    • addFragmentComposition

      public static FragmentComposition addFragmentComposition(FragmentComposition fragmentComposition)
      Adds the fragment composition to the database. Also notifies the appropriate model listeners.

      Important: Inspect FragmentCompositionLocalServiceImpl 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:
      fragmentComposition - the fragment composition
      Returns:
      the fragment composition that was added
    • addFragmentComposition

      public static FragmentComposition addFragmentComposition(String externalReferenceCode, long userId, long groupId, long fragmentCollectionId, String fragmentCompositionKey, String name, String description, String data, long previewFileEntryId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createFragmentComposition

      public static FragmentComposition createFragmentComposition(long fragmentCompositionId)
      Creates a new fragment composition with the primary key. Does not add the fragment composition to the database.
      Parameters:
      fragmentCompositionId - the primary key for the new fragment composition
      Returns:
      the new fragment composition
    • 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
    • deleteFragmentComposition

      public static FragmentComposition deleteFragmentComposition(FragmentComposition fragmentComposition) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the fragment composition from the database. Also notifies the appropriate model listeners.

      Important: Inspect FragmentCompositionLocalServiceImpl 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:
      fragmentComposition - the fragment composition
      Returns:
      the fragment composition that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFragmentComposition

      public static FragmentComposition deleteFragmentComposition(long fragmentCompositionId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the fragment composition with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect FragmentCompositionLocalServiceImpl 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:
      fragmentCompositionId - the primary key of the fragment composition
      Returns:
      the fragment composition that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a fragment composition with the primary key could not be found
    • deleteFragmentComposition

      public static FragmentComposition deleteFragmentComposition(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.fragment.model.impl.FragmentCompositionModelImpl.

      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.fragment.model.impl.FragmentCompositionModelImpl.

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

      public static FragmentComposition fetchFragmentComposition(long fragmentCompositionId)
    • fetchFragmentComposition

      public static FragmentComposition fetchFragmentComposition(long groupId, String fragmentCompositionKey)
    • fetchFragmentCompositionByExternalReferenceCode

      public static FragmentComposition fetchFragmentCompositionByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchFragmentCompositionByUuidAndGroupId

      public static FragmentComposition fetchFragmentCompositionByUuidAndGroupId(String uuid, long groupId)
      Returns the fragment composition matching the UUID and group.
      Parameters:
      uuid - the fragment composition's UUID
      groupId - the primary key of the group
      Returns:
      the matching fragment composition, or null if a matching fragment composition could not be found
    • generateFragmentCompositionKey

      public static String generateFragmentCompositionKey(long groupId, String name)
    • 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)
    • getFragmentComposition

      public static FragmentComposition getFragmentComposition(long fragmentCompositionId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the fragment composition with the primary key.
      Parameters:
      fragmentCompositionId - the primary key of the fragment composition
      Returns:
      the fragment composition
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a fragment composition with the primary key could not be found
    • getFragmentCompositionByExternalReferenceCode

      public static FragmentComposition getFragmentCompositionByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFragmentCompositionByUuidAndGroupId

      public static FragmentComposition getFragmentCompositionByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the fragment composition matching the UUID and group.
      Parameters:
      uuid - the fragment composition's UUID
      groupId - the primary key of the group
      Returns:
      the matching fragment composition
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching fragment composition could not be found
    • getFragmentCompositions

      public static List<FragmentComposition> getFragmentCompositions(int start, int end)
      Returns a range of all the fragment compositions.

      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.fragment.model.impl.FragmentCompositionModelImpl.

      Parameters:
      start - the lower bound of the range of fragment compositions
      end - the upper bound of the range of fragment compositions (not inclusive)
      Returns:
      the range of fragment compositions
    • getFragmentCompositions

      public static List<FragmentComposition> getFragmentCompositions(long fragmentCollectionId)
    • getFragmentCompositions

      public static List<FragmentComposition> getFragmentCompositions(long fragmentCollectionId, int start, int end)
    • getFragmentCompositions

      public static List<FragmentComposition> getFragmentCompositions(long groupId, long fragmentCollectionId, int status)
    • getFragmentCompositions

      public static List<FragmentComposition> getFragmentCompositions(long groupId, long fragmentCollectionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentComposition> orderByComparator)
    • getFragmentCompositions

      public static List<FragmentComposition> getFragmentCompositions(long groupId, long fragmentCollectionId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentComposition> orderByComparator)
    • getFragmentCompositionsByUuidAndCompanyId

      public static List<FragmentComposition> getFragmentCompositionsByUuidAndCompanyId(String uuid, long companyId)
      Returns all the fragment compositions matching the UUID and company.
      Parameters:
      uuid - the UUID of the fragment compositions
      companyId - the primary key of the company
      Returns:
      the matching fragment compositions, or an empty list if no matches were found
    • getFragmentCompositionsByUuidAndCompanyId

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

      public static int getFragmentCompositionsCount()
      Returns the number of fragment compositions.
      Returns:
      the number of fragment compositions
    • getFragmentCompositionsCount

      public static int getFragmentCompositionsCount(long fragmentCollectionId)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • 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
    • getTempFileNames

      public static String[] getTempFileNames(long userId, long groupId, String folderName) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUniqueFragmentCompositionName

      public static String getUniqueFragmentCompositionName(long groupId, long fragmentCollectionId, String name)
    • moveFragmentComposition

      public static FragmentComposition moveFragmentComposition(long fragmentCompositionId, long fragmentCollectionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFragmentComposition

      public static FragmentComposition updateFragmentComposition(FragmentComposition fragmentComposition)
      Updates the fragment composition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect FragmentCompositionLocalServiceImpl 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:
      fragmentComposition - the fragment composition
      Returns:
      the fragment composition that was updated
    • updateFragmentComposition

      public static FragmentComposition updateFragmentComposition(long fragmentCompositionId, long previewFileEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFragmentComposition

      public static FragmentComposition updateFragmentComposition(long userId, long fragmentCompositionId, long fragmentCollectionId, String name, String description, String data, long previewFileEntryId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFragmentComposition

      public static FragmentComposition updateFragmentComposition(long fragmentCompositionId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static FragmentCompositionLocalService getService()