com.liferay.portal.workflow.kaleo.service

Class KaleoActionLocalServiceUtil

java.lang.Object

com.liferay.portal.workflow.kaleo.service.KaleoActionLocalServiceUtil

public class KaleoActionLocalServiceUtil
extends java.lang.Object

Provides the local service utility for KaleoAction. This utility wraps com.liferay.portal.workflow.kaleo.service.impl.KaleoActionLocalServiceImpl 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:

KaleoActionLocalService

Constructor Summary

Constructors

Constructor and Description
KaleoActionLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static KaleoAction	addKaleoAction(KaleoAction kaleoAction) Adds the kaleo action to the database.
static KaleoAction	addKaleoAction(java.lang.String kaleoClassName, long kaleoClassPK, long kaleoDefinitionId, long kaleoDefinitionVersionId, java.lang.String kaleoNodeName, Action action, ServiceContext serviceContext)
static KaleoAction	createKaleoAction(long kaleoActionId) Creates a new kaleo action with the primary key.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static void	deleteCompanyKaleoActions(long companyId)
static KaleoAction	deleteKaleoAction(KaleoAction kaleoAction) Deletes the kaleo action from the database.
static KaleoAction	deleteKaleoAction(long kaleoActionId) Deletes the kaleo action with the primary key from the database.
static void	deleteKaleoDefinitionVersionKaleoActions(long kaleoDefinitionVersionId)
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 KaleoAction	fetchKaleoAction(long kaleoActionId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static KaleoAction	getKaleoAction(long kaleoActionId) Returns the kaleo action with the primary key.
static java.util.List<KaleoAction>	getKaleoActions(int start, int end) Returns a range of all the kaleo actions.
static java.util.List<KaleoAction>	getKaleoActions(long companyId, java.lang.String kaleoClassName, long kaleoClassPK)
static java.util.List<KaleoAction>	getKaleoActions(long companyId, java.lang.String kaleoClassName, long kaleoClassPK, java.lang.String executionType)
static java.util.List<KaleoAction>	getKaleoActions(java.lang.String kaleoClassName, long kaleoClassPK) Deprecated. As of Athanasius (7.3.x), replaced by getKaleoActions(long, String, long)
static java.util.List<KaleoAction>	getKaleoActions(java.lang.String kaleoClassName, long kaleoClassPK, java.lang.String executionType) Deprecated. As of Athanasius (7.3.x), replaced by getKaleoActions(long, String, long, String)
static int	getKaleoActionsCount() Returns the number of kaleo actions.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static KaleoActionLocalService	getService()
static KaleoAction	updateKaleoAction(KaleoAction kaleoAction) Updates the kaleo action 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

KaleoActionLocalServiceUtil

public KaleoActionLocalServiceUtil()

Method Detail

addKaleoAction

public static KaleoAction addKaleoAction(KaleoAction kaleoAction)

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

Parameters:

kaleoAction - the kaleo action

Returns:

the kaleo action that was added

addKaleoAction

public static KaleoAction addKaleoAction(java.lang.String kaleoClassName,
                                         long kaleoClassPK,
                                         long kaleoDefinitionId,
                                         long kaleoDefinitionVersionId,
                                         java.lang.String kaleoNodeName,
                                         Action action,
                                         ServiceContext serviceContext)
                                  throws PortalException

Throws:

PortalException

createKaleoAction

public static KaleoAction createKaleoAction(long kaleoActionId)

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

Parameters:

kaleoActionId - the primary key for the new kaleo action

Returns:

the new kaleo action

createPersistedModel

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

Throws:

PortalException

deleteCompanyKaleoActions

public static void deleteCompanyKaleoActions(long companyId)

deleteKaleoAction

public static KaleoAction deleteKaleoAction(KaleoAction kaleoAction)

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

Parameters:

kaleoAction - the kaleo action

Returns:

the kaleo action that was removed

deleteKaleoAction

public static KaleoAction deleteKaleoAction(long kaleoActionId)
                                     throws PortalException

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

Parameters:

kaleoActionId - the primary key of the kaleo action

Returns:

the kaleo action that was removed

Throws:

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

deleteKaleoDefinitionVersionKaleoActions

public static void deleteKaleoDefinitionVersionKaleoActions(long kaleoDefinitionVersionId)

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

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

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

fetchKaleoAction

public static KaleoAction fetchKaleoAction(long kaleoActionId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getKaleoAction

public static KaleoAction getKaleoAction(long kaleoActionId)
                                  throws PortalException

Returns the kaleo action with the primary key.

Parameters:

kaleoActionId - the primary key of the kaleo action

Returns:

the kaleo action

Throws:

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

getKaleoActions

public static java.util.List<KaleoAction> getKaleoActions(int start,
                                                          int end)

Returns a range of all the kaleo actions.

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

Parameters:

start - the lower bound of the range of kaleo actions

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

Returns:

the range of kaleo actions

getKaleoActions

public static java.util.List<KaleoAction> getKaleoActions(long companyId,
                                                          java.lang.String kaleoClassName,
                                                          long kaleoClassPK)

getKaleoActions

public static java.util.List<KaleoAction> getKaleoActions(long companyId,
                                                          java.lang.String kaleoClassName,
                                                          long kaleoClassPK,
                                                          java.lang.String executionType)

getKaleoActions

@Deprecated
public static java.util.List<KaleoAction> getKaleoActions(java.lang.String kaleoClassName,
                                                                      long kaleoClassPK)

Deprecated. As of Athanasius (7.3.x), replaced by getKaleoActions(long, String, long)

getKaleoActions

@Deprecated
public static java.util.List<KaleoAction> getKaleoActions(java.lang.String kaleoClassName,
                                                                      long kaleoClassPK,
                                                                      java.lang.String executionType)

Deprecated. As of Athanasius (7.3.x), replaced by getKaleoActions(long, String, long, String)

getKaleoActionsCount

public static int getKaleoActionsCount()

Returns the number of kaleo actions.

Returns:

the number of kaleo actions

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

updateKaleoAction

public static KaleoAction updateKaleoAction(KaleoAction kaleoAction)

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

Parameters:

kaleoAction - the kaleo action

Returns:

the kaleo action that was updated

getService

public static KaleoActionLocalService getService()