com.liferay.portal.workflow.kaleo.service

Class KaleoNotificationLocalServiceUtil

java.lang.Object

com.liferay.portal.workflow.kaleo.service.KaleoNotificationLocalServiceUtil

public class KaleoNotificationLocalServiceUtil
extends java.lang.Object

Provides the local service utility for KaleoNotification. This utility wraps com.liferay.portal.workflow.kaleo.service.impl.KaleoNotificationLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:

KaleoNotificationLocalService

Constructor Summary

Constructors

Constructor and Description
KaleoNotificationLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static KaleoNotification	addKaleoNotification(KaleoNotification kaleoNotification) Adds the kaleo notification to the database.
static KaleoNotification	addKaleoNotification(java.lang.String kaleoClassName, long kaleoClassPK, long kaleoDefinitionId, long kaleoDefinitionVersionId, java.lang.String kaleoNodeName, Notification notification, ServiceContext serviceContext)
static KaleoNotification	createKaleoNotification(long kaleoNotificationId) Creates a new kaleo notification with the primary key.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static void	deleteCompanyKaleoNotifications(long companyId)
static void	deleteKaleoDefinitionVersionKaleoNotifications(long kaleoDefinitionVersionId)
static KaleoNotification	deleteKaleoNotification(KaleoNotification kaleoNotification) Deletes the kaleo notification from the database.
static KaleoNotification	deleteKaleoNotification(long kaleoNotificationId) Deletes the kaleo notification with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <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.
static <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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static KaleoNotification	fetchKaleoNotification(long kaleoNotificationId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static KaleoNotification	getKaleoNotification(long kaleoNotificationId) Returns the kaleo notification with the primary key.
static java.util.List<KaleoNotification>	getKaleoNotifications(int start, int end) Returns a range of all the kaleo notifications.
static java.util.List<KaleoNotification>	getKaleoNotifications(java.lang.String kaleoClassName, long kaleoClassPK)
static java.util.List<KaleoNotification>	getKaleoNotifications(java.lang.String kaleoClassName, long kaleoClassPK, java.lang.String executionType)
static int	getKaleoNotificationsCount() Returns the number of kaleo notifications.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static KaleoNotificationLocalService	getService()
static KaleoNotification	updateKaleoNotification(KaleoNotification kaleoNotification) Updates the kaleo notification in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KaleoNotificationLocalServiceUtil

public KaleoNotificationLocalServiceUtil()

Method Detail

addKaleoNotification

public static KaleoNotification addKaleoNotification(KaleoNotification kaleoNotification)

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

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

kaleoNotification - the kaleo notification

Returns:

the kaleo notification that was added

addKaleoNotification

public static KaleoNotification addKaleoNotification(java.lang.String kaleoClassName,
                                                     long kaleoClassPK,
                                                     long kaleoDefinitionId,
                                                     long kaleoDefinitionVersionId,
                                                     java.lang.String kaleoNodeName,
                                                     Notification notification,
                                                     ServiceContext serviceContext)
                                              throws PortalException

Throws:

PortalException

createKaleoNotification

public static KaleoNotification createKaleoNotification(long kaleoNotificationId)

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

Parameters:

kaleoNotificationId - the primary key for the new kaleo notification

Returns:

the new kaleo notification

createPersistedModel

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

Throws:

PortalException

deleteCompanyKaleoNotifications

public static void deleteCompanyKaleoNotifications(long companyId)

deleteKaleoDefinitionVersionKaleoNotifications

public static void deleteKaleoDefinitionVersionKaleoNotifications(long kaleoDefinitionVersionId)

deleteKaleoNotification

public static KaleoNotification deleteKaleoNotification(KaleoNotification kaleoNotification)

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

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

kaleoNotification - the kaleo notification

Returns:

the kaleo notification that was removed

deleteKaleoNotification

public static KaleoNotification deleteKaleoNotification(long kaleoNotificationId)
                                                 throws PortalException

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

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

kaleoNotificationId - the primary key of the kaleo notification

Returns:

the kaleo notification that was removed

Throws:

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

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public static <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.KaleoNotificationModelImpl.

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

public static <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.KaleoNotificationModelImpl.

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

public static 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

public static 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

fetchKaleoNotification

public static KaleoNotification fetchKaleoNotification(long kaleoNotificationId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getKaleoNotification

public static KaleoNotification getKaleoNotification(long kaleoNotificationId)
                                              throws PortalException

Returns the kaleo notification with the primary key.

Parameters:

kaleoNotificationId - the primary key of the kaleo notification

Returns:

the kaleo notification

Throws:

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

getKaleoNotifications

public static java.util.List<KaleoNotification> getKaleoNotifications(int start,
                                                                      int end)

Returns a range of all the kaleo notifications.

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

Parameters:

start - the lower bound of the range of kaleo notifications

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

Returns:

the range of kaleo notifications

getKaleoNotifications

public static java.util.List<KaleoNotification> getKaleoNotifications(java.lang.String kaleoClassName,
                                                                      long kaleoClassPK)

getKaleoNotifications

public static java.util.List<KaleoNotification> getKaleoNotifications(java.lang.String kaleoClassName,
                                                                      long kaleoClassPK,
                                                                      java.lang.String executionType)

getKaleoNotificationsCount

public static int getKaleoNotificationsCount()

Returns the number of kaleo notifications.

Returns:

the number of kaleo notifications

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

updateKaleoNotification

public static KaleoNotification updateKaleoNotification(KaleoNotification kaleoNotification)

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

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

kaleoNotification - the kaleo notification

Returns:

the kaleo notification that was updated

getService

public static KaleoNotificationLocalService getService()