Interface SourceLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
SourceLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface SourceLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for Source. 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

    • addSource

      Source addSource(long userId, long groupId, Map<Locale,String> nameMap, String driverClassName, String driverUrl, String driverUserName, String driverPassword, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSource

      @Indexable(type=REINDEX) Source addSource(Source source)
      Adds the source to the database. Also notifies the appropriate model listeners.

      Important: Inspect SourceLocalServiceImpl 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:
      source - the source
      Returns:
      the source that was added
    • 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
    • createSource

      @Transactional(enabled=false) Source createSource(long sourceId)
      Creates a new source with the primary key. Does not add the source to the database.
      Parameters:
      sourceId - the primary key for the new source
      Returns:
      the new source
    • 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
    • deleteSource

      @Indexable(type=DELETE) Source deleteSource(long sourceId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the source with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect SourceLocalServiceImpl 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:
      sourceId - the primary key of the source
      Returns:
      the source that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a source with the primary key could not be found
    • deleteSource

      @Indexable(type=DELETE) @SystemEvent(type=1) Source deleteSource(Source source) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the source from the database. Also notifies the appropriate model listeners.

      Important: Inspect SourceLocalServiceImpl 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:
      source - the source
      Returns:
      the source that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSources

      void deleteSources(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      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.portal.reports.engine.console.model.impl.SourceModelImpl.

      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.portal.reports.engine.console.model.impl.SourceModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) Source fetchSource(long sourceId)
    • fetchSourceByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) Source fetchSourceByUuidAndGroupId(String uuid, long groupId)
      Returns the source matching the UUID and group.
      Parameters:
      uuid - the source's UUID
      groupId - the primary key of the group
      Returns:
      the matching source, or null if a matching source could not be found
    • getActionableDynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) String[] getAttachmentsFileNames(Source source)
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • 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
    • getSource

      @Transactional(propagation=SUPPORTS, readOnly=true) Source getSource(long sourceId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the source with the primary key.
      Parameters:
      sourceId - the primary key of the source
      Returns:
      the source
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a source with the primary key could not be found
    • getSourceByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) Source getSourceByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the source matching the UUID and group.
      Parameters:
      uuid - the source's UUID
      groupId - the primary key of the group
      Returns:
      the matching source
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching source could not be found
    • getSources

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Source> getSources(int start, int end)
      Returns a range of all the sources.

      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.reports.engine.console.model.impl.SourceModelImpl.

      Parameters:
      start - the lower bound of the range of sources
      end - the upper bound of the range of sources (not inclusive)
      Returns:
      the range of sources
    • getSources

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Source> getSources(long groupId, String name, String driverUrl, boolean andSearch, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Source> orderByComparator)
    • getSourcesByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Source> getSourcesByUuidAndCompanyId(String uuid, long companyId)
      Returns all the sources matching the UUID and company.
      Parameters:
      uuid - the UUID of the sources
      companyId - the primary key of the company
      Returns:
      the matching sources, or an empty list if no matches were found
    • getSourcesByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Source> getSourcesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Source> orderByComparator)
      Returns a range of sources matching the UUID and company.
      Parameters:
      uuid - the UUID of the sources
      companyId - the primary key of the company
      start - the lower bound of the range of sources
      end - the upper bound of the range of sources (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching sources, or an empty list if no matches were found
    • getSourcesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getSourcesCount()
      Returns the number of sources.
      Returns:
      the number of sources
    • getSourcesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getSourcesCount(long groupId, String name, String driverUrl, boolean andSearch)
    • updateSource

      Source updateSource(long sourceId, Map<Locale,String> nameMap, String driverClassName, String driverUrl, String driverUserName, String driverPassword, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSource

      @Indexable(type=REINDEX) Source updateSource(Source source)
      Updates the source in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect SourceLocalServiceImpl 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:
      source - the source
      Returns:
      the source that was updated