Interface ServiceComponentLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ServiceComponentLocalServiceWrapper

Provides the local service interface for ServiceComponent. 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}
  • Method Details

    • addServiceComponent

      @Indexable(type=REINDEX) ServiceComponent addServiceComponent(ServiceComponent serviceComponent)
      Adds the service component to the database. Also notifies the appropriate model listeners.

      Important: Inspect ServiceComponentLocalServiceImpl 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:
      serviceComponent - the service component
      Returns:
      the service component that was added
    • createPersistedModel

      PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • createServiceComponent

      @Transactional(enabled=false) ServiceComponent createServiceComponent(long serviceComponentId)
      Creates a new service component with the primary key. Does not add the service component to the database.
      Parameters:
      serviceComponentId - the primary key for the new service component
      Returns:
      the new service component
    • deletePersistedModel

      PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • deleteServiceComponent

      @Indexable(type=DELETE) ServiceComponent deleteServiceComponent(long serviceComponentId) throws PortalException
      Deletes the service component with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect ServiceComponentLocalServiceImpl 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:
      serviceComponentId - the primary key of the service component
      Returns:
      the service component that was removed
      Throws:
      PortalException - if a service component with the primary key could not be found
    • deleteServiceComponent

      @Indexable(type=DELETE) ServiceComponent deleteServiceComponent(ServiceComponent serviceComponent)
      Deletes the service component from the database. Also notifies the appropriate model listeners.

      Important: Inspect ServiceComponentLocalServiceImpl 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:
      serviceComponent - the service component
      Returns:
      the service component that was removed
    • dslQuery

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

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

    • dynamicQuery

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

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

      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(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.ServiceComponentModelImpl.

      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(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(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
    • fetchServiceComponent

      @Transactional(propagation=SUPPORTS, readOnly=true) ServiceComponent fetchServiceComponent(long serviceComponentId)
    • getActionableDynamicQuery

    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getLatestServiceComponents

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ServiceComponent> getLatestServiceComponents()
    • getOSGiServiceIdentifier

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

      @Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      getPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • getServiceComponent

      @Transactional(propagation=SUPPORTS, readOnly=true) ServiceComponent getServiceComponent(long serviceComponentId) throws PortalException
      Returns the service component with the primary key.
      Parameters:
      serviceComponentId - the primary key of the service component
      Returns:
      the service component
      Throws:
      PortalException - if a service component with the primary key could not be found
    • getServiceComponents

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ServiceComponent> getServiceComponents(int start, int end)
      Returns a range of all the service components.

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

      Parameters:
      start - the lower bound of the range of service components
      end - the upper bound of the range of service components (not inclusive)
      Returns:
      the range of service components
    • getServiceComponentsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getServiceComponentsCount()
      Returns the number of service components.
      Returns:
      the number of service components
    • initServiceComponent

      ServiceComponent initServiceComponent(ServiceComponentConfiguration serviceComponentConfiguration, ClassLoader classLoader, String buildNamespace, long buildNumber, long buildDate) throws PortalException
      Throws:
      PortalException
    • updateServiceComponent

      @Indexable(type=REINDEX) ServiceComponent updateServiceComponent(ServiceComponent serviceComponent)
      Updates the service component in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ServiceComponentLocalServiceImpl 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:
      serviceComponent - the service component
      Returns:
      the service component that was updated
    • upgradeDB

      void upgradeDB(ClassLoader classLoader, String buildNamespace, long buildNumber, ServiceComponent previousServiceComponent, String tablesSQL, String sequencesSQL, String indexesSQL) throws Exception
      Throws:
      Exception