Interface KaleoInstanceLocalService

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

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

    • addKaleoInstance

      @Indexable(type=REINDEX) KaleoInstance addKaleoInstance(KaleoInstance kaleoInstance)
      Adds the kaleo instance to the database. Also notifies the appropriate model listeners.

      Important: Inspect KaleoInstanceLocalServiceImpl 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:
      kaleoInstance - the kaleo instance
      Returns:
      the kaleo instance that was added
    • addKaleoInstance

      @Indexable(type=REINDEX) KaleoInstance addKaleoInstance(long kaleoDefinitionId, long kaleoDefinitionVersionId, String kaleoDefinitionName, int kaleoDefinitionVersion, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • completeKaleoInstance

      @Indexable(type=REINDEX) KaleoInstance completeKaleoInstance(long kaleoInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createKaleoInstance

      @Transactional(enabled=false) KaleoInstance createKaleoInstance(long kaleoInstanceId)
      Creates a new kaleo instance with the primary key. Does not add the kaleo instance to the database.
      Parameters:
      kaleoInstanceId - the primary key for the new kaleo instance
      Returns:
      the new kaleo instance
    • 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
    • deleteCompanyKaleoInstances

      void deleteCompanyKaleoInstances(long companyId)
    • deleteKaleoDefinitionVersionKaleoInstances

      void deleteKaleoDefinitionVersionKaleoInstances(long kaleoDefinitionVersionId)
    • deleteKaleoInstance

      @Indexable(type=DELETE) KaleoInstance deleteKaleoInstance(KaleoInstance kaleoInstance)
      Deletes the kaleo instance from the database. Also notifies the appropriate model listeners.

      Important: Inspect KaleoInstanceLocalServiceImpl 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:
      kaleoInstance - the kaleo instance
      Returns:
      the kaleo instance that was removed
    • deleteKaleoInstance

      @Indexable(type=DELETE) KaleoInstance deleteKaleoInstance(long kaleoInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the kaleo instance with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect KaleoInstanceLocalServiceImpl 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:
      kaleoInstanceId - the primary key of the kaleo instance
      Returns:
      the kaleo instance that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a kaleo instance with the primary key could not be found
    • 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.portal.workflow.kaleo.model.impl.KaleoInstanceModelImpl.

      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.workflow.kaleo.model.impl.KaleoInstanceModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) KaleoInstance fetchKaleoInstance(long kaleoInstanceId)
    • fetchKaleoInstance

      @Transactional(propagation=SUPPORTS, readOnly=true) KaleoInstance fetchKaleoInstance(long kaleoInstanceId, long companyId, long userId)
    • getActionableDynamicQuery

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getKaleoDefinitionKaleoInstancesCount(long kaleoDefinitionId, boolean completed)
    • getKaleoInstance

      @Transactional(propagation=SUPPORTS, readOnly=true) KaleoInstance getKaleoInstance(long kaleoInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the kaleo instance with the primary key.
      Parameters:
      kaleoInstanceId - the primary key of the kaleo instance
      Returns:
      the kaleo instance
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a kaleo instance with the primary key could not be found
    • getKaleoInstances

      @Transactional(propagation=SUPPORTS, readOnly=true) List<KaleoInstance> getKaleoInstances(int start, int end)
      Returns a range of all the kaleo instances.

      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.workflow.kaleo.model.impl.KaleoInstanceModelImpl.

      Parameters:
      start - the lower bound of the range of kaleo instances
      end - the upper bound of the range of kaleo instances (not inclusive)
      Returns:
      the range of kaleo instances
    • getKaleoInstances

      @Transactional(propagation=SUPPORTS, readOnly=true) List<KaleoInstance> getKaleoInstances(Long userId, String assetClassName, Long assetClassPK, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getKaleoInstances

      @Transactional(propagation=SUPPORTS, readOnly=true) List<KaleoInstance> getKaleoInstances(Long userId, String[] assetClassNames, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getKaleoInstances

      @Transactional(propagation=SUPPORTS, readOnly=true) List<KaleoInstance> getKaleoInstances(String kaleoDefinitionName, int kaleoDefinitionVersion, boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getKaleoInstancesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getKaleoInstancesCount()
      Returns the number of kaleo instances.
      Returns:
      the number of kaleo instances
    • getKaleoInstancesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getKaleoInstancesCount(long kaleoDefinitionVersionId, boolean completed)
    • getKaleoInstancesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getKaleoInstancesCount(Long userId, String assetClassName, Long assetClassPK, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    • getKaleoInstancesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getKaleoInstancesCount(Long userId, String[] assetClassNames, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    • getKaleoInstancesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getKaleoInstancesCount(String kaleoDefinitionName, int kaleoDefinitionVersion, boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    • 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
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) List<KaleoInstance> search(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    • searchCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    • searchKaleoInstances

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.search.BaseModelSearchResult<KaleoInstance> searchKaleoInstances(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, boolean searchByActiveWorkflowHandlers, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateActive

      @Indexable(type=REINDEX) KaleoInstance updateActive(long userId, long kaleoInstanceId, boolean active) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateKaleoInstance

      @Indexable(type=REINDEX) KaleoInstance updateKaleoInstance(KaleoInstance kaleoInstance)
      Updates the kaleo instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect KaleoInstanceLocalServiceImpl 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:
      kaleoInstance - the kaleo instance
      Returns:
      the kaleo instance that was updated
    • updateKaleoInstance

      @Indexable(type=REINDEX) KaleoInstance updateKaleoInstance(long kaleoInstanceId, long rootKaleoInstanceTokenId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateKaleoInstance

      @Indexable(type=REINDEX) @Retry(acceptor=com.liferay.portal.kernel.service.ExceptionRetryAcceptor.class, properties=@Property(name="EXCEPTION_NAME",value="org.hibernate.StaleObjectStateException")) KaleoInstance updateKaleoInstance(long kaleoInstanceId, Map<String,Serializable> workflowContext) 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<KaleoInstance> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<KaleoInstance>
    • getModelClass

      @Transactional(enabled=false) Class<KaleoInstance> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<KaleoInstance>
    • 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<KaleoInstance>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<KaleoInstance>
      Throws:
      E extends Throwable