Interface FragmentCompositionLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<FragmentComposition>, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
FragmentCompositionLocalServiceWrapper

@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface FragmentCompositionLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<FragmentComposition>, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for FragmentComposition. 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:
  • Method Details

    • addFragmentComposition

      @Indexable(type=REINDEX) 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

      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

      @Transactional(enabled=false) 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

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFragmentComposition

      @Indexable(type=DELETE) @SystemEvent(type=1) 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

      @Indexable(type=DELETE) 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

      FragmentComposition deleteFragmentComposition(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) FragmentComposition fetchFragmentComposition(long fragmentCompositionId)
    • fetchFragmentComposition

      @Transactional(propagation=SUPPORTS, readOnly=true) FragmentComposition fetchFragmentComposition(long groupId, String fragmentCompositionKey)
    • fetchFragmentCompositionByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) FragmentComposition fetchFragmentCompositionByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchFragmentCompositionByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      String generateFragmentCompositionKey(long groupId, String name)
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getFragmentComposition

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) FragmentComposition getFragmentCompositionByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFragmentCompositionByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<FragmentComposition> getFragmentCompositions(long fragmentCollectionId)
    • getFragmentCompositions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<FragmentComposition> getFragmentCompositions(long fragmentCollectionId, int start, int end)
    • getFragmentCompositions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<FragmentComposition> getFragmentCompositions(long groupId, long fragmentCollectionId, int status)
    • getFragmentCompositions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<FragmentComposition> getFragmentCompositions(long groupId, long fragmentCollectionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentComposition> orderByComparator)
    • getFragmentCompositions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<FragmentComposition> getFragmentCompositions(long groupId, long fragmentCollectionId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FragmentComposition> orderByComparator)
    • getFragmentCompositionsByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getFragmentCompositionsCount()
      Returns the number of fragment compositions.
      Returns:
      the number of fragment compositions
    • getFragmentCompositionsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getFragmentCompositionsCount(long fragmentCollectionId)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getTempFileNames

      @Transactional(propagation=SUPPORTS, readOnly=true) String[] getTempFileNames(long userId, long groupId, String folderName) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUniqueFragmentCompositionName

      @Transactional(propagation=SUPPORTS, readOnly=true) String getUniqueFragmentCompositionName(long groupId, long fragmentCollectionId, String name)
    • moveFragmentComposition

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

      @Indexable(type=REINDEX) 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

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

      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

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

      @Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<FragmentComposition> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<FragmentComposition>
    • getModelClass

      @Transactional(enabled=false) Class<FragmentComposition> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<FragmentComposition>
    • updateWithUnsafeFunction

      @Transactional(rollbackFor=java.lang.Throwable.class) <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<FragmentComposition>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<FragmentComposition>
      Throws:
      E extends Throwable