com.liferay.portal.workflow.kaleo.service

Interface KaleoTimerLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

KaleoTimerLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface KaleoTimerLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for KaleoTimer. 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:

KaleoTimerLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
KaleoTimer	addKaleoTimer(KaleoTimer kaleoTimer) Adds the kaleo timer to the database.
KaleoTimer	addKaleoTimer(java.lang.String kaleoClassName, long kaleoClassPK, long kaleoDefinitionId, long kaleoDefinitionVersionId, Timer timer, ServiceContext serviceContext)
KaleoTimer	createKaleoTimer(long kaleoTimerId) Creates a new kaleo timer with the primary key.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
KaleoTimer	deleteKaleoTimer(KaleoTimer kaleoTimer) Deletes the kaleo timer from the database.
KaleoTimer	deleteKaleoTimer(long kaleoTimerId) Deletes the kaleo timer with the primary key from the database.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
<T> T	dslQuery(DSLQuery dslQuery)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
KaleoTimer	fetchKaleoTimer(long kaleoTimerId)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
KaleoTimer	getKaleoTimer(long kaleoTimerId) Returns the kaleo timer with the primary key.
java.util.List<KaleoTimer>	getKaleoTimers(int start, int end) Returns a range of all the kaleo timers.
java.util.List<KaleoTimer>	getKaleoTimers(java.lang.String kaleoClassName, long kaleoClassPK)
java.util.List<KaleoTimer>	getKaleoTimers(java.lang.String kaleoClassName, long kaleoClassPK, boolean blocking)
int	getKaleoTimersCount() Returns the number of kaleo timers.
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
KaleoTimer	updateKaleoTimer(KaleoTimer kaleoTimer) Updates the kaleo timer in the database or adds it if it does not yet exist.

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addKaleoTimer

@Indexable(type=REINDEX)
KaleoTimer addKaleoTimer(KaleoTimer kaleoTimer)

Adds the kaleo timer to the database. Also notifies the appropriate model listeners.

Important: Inspect KaleoTimerLocalServiceImpl 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:

kaleoTimer - the kaleo timer

Returns:

the kaleo timer that was added

addKaleoTimer

KaleoTimer addKaleoTimer(java.lang.String kaleoClassName,
                         long kaleoClassPK,
                         long kaleoDefinitionId,
                         long kaleoDefinitionVersionId,
                         Timer timer,
                         ServiceContext serviceContext)
                  throws PortalException

Throws:

PortalException

createKaleoTimer

@Transactional(enabled=false)
KaleoTimer createKaleoTimer(long kaleoTimerId)

Creates a new kaleo timer with the primary key. Does not add the kaleo timer to the database.

Parameters:

kaleoTimerId - the primary key for the new kaleo timer

Returns:

the new kaleo timer

createPersistedModel

PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                             throws PortalException

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteKaleoTimer

@Indexable(type=DELETE)
KaleoTimer deleteKaleoTimer(KaleoTimer kaleoTimer)

Deletes the kaleo timer from the database. Also notifies the appropriate model listeners.

Important: Inspect KaleoTimerLocalServiceImpl 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:

kaleoTimer - the kaleo timer

Returns:

the kaleo timer that was removed

deleteKaleoTimer

@Indexable(type=DELETE)
KaleoTimer deleteKaleoTimer(long kaleoTimerId)
                                             throws PortalException

Deletes the kaleo timer with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect KaleoTimerLocalServiceImpl 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:

kaleoTimerId - the primary key of the kaleo timer

Returns:

the kaleo timer that was removed

Throws:

PortalException - if a kaleo timer with the primary key could not be found

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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> java.util.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.workflow.kaleo.model.impl.KaleoTimerModelImpl.

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> java.util.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.workflow.kaleo.model.impl.KaleoTimerModelImpl.

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

fetchKaleoTimer

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KaleoTimer fetchKaleoTimer(long kaleoTimerId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

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

getKaleoTimer

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KaleoTimer getKaleoTimer(long kaleoTimerId)
                                                                                     throws PortalException

Returns the kaleo timer with the primary key.

Parameters:

kaleoTimerId - the primary key of the kaleo timer

Returns:

the kaleo timer

Throws:

PortalException - if a kaleo timer with the primary key could not be found

getKaleoTimers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KaleoTimer> getKaleoTimers(int start,
                                                                                                             int end)

Returns a range of all the kaleo timers.

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

Parameters:

start - the lower bound of the range of kaleo timers

end - the upper bound of the range of kaleo timers (not inclusive)

Returns:

the range of kaleo timers

getKaleoTimers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KaleoTimer> getKaleoTimers(java.lang.String kaleoClassName,
                                                                                                             long kaleoClassPK)

getKaleoTimers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KaleoTimer> getKaleoTimers(java.lang.String kaleoClassName,
                                                                                                             long kaleoClassPK,
                                                                                                             boolean blocking)

getKaleoTimersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKaleoTimersCount()

Returns the number of kaleo timers.

Returns:

the number of kaleo timers

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

updateKaleoTimer

@Indexable(type=REINDEX)
KaleoTimer updateKaleoTimer(KaleoTimer kaleoTimer)

Updates the kaleo timer in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect KaleoTimerLocalServiceImpl 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:

kaleoTimer - the kaleo timer

Returns:

the kaleo timer that was updated