com.liferay.portal.workflow.kaleo.service

Interface KaleoDefinitionLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

KaleoDefinitionLocalServiceWrapper

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

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

KaleoDefinitionLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
void	activateKaleoDefinition(long kaleoDefinitionId, long kaleoDefinitionVersionId, long startKaleoNodeId, ServiceContext serviceContext)
void	activateKaleoDefinition(long kaleoDefinitionId, ServiceContext serviceContext)
void	activateKaleoDefinition(java.lang.String name, int version, ServiceContext serviceContext)
KaleoDefinition	addKaleoDefinition(KaleoDefinition kaleoDefinition) Adds the kaleo definition to the database.
KaleoDefinition	addKaleoDefinition(java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String content, int version, ServiceContext serviceContext) Deprecated. As of Athanasius (7.3.x), replaced by addKaleoDefinition(String, String, String, String, String, int, ServiceContext)
KaleoDefinition	addKaleoDefinition(java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String scope, int version, ServiceContext serviceContext)
KaleoDefinition	createKaleoDefinition(long kaleoDefinitionId) Creates a new kaleo definition with the primary key.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
void	deactivateKaleoDefinition(java.lang.String name, int version, ServiceContext serviceContext)
void	deleteCompanyKaleoDefinitions(long companyId)
KaleoDefinition	deleteKaleoDefinition(KaleoDefinition kaleoDefinition) Deletes the kaleo definition from the database.
KaleoDefinition	deleteKaleoDefinition(long kaleoDefinitionId) Deletes the kaleo definition with the primary key from the database.
void	deleteKaleoDefinition(java.lang.String name, ServiceContext serviceContext)
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.
KaleoDefinition	fetchKaleoDefinition(long kaleoDefinitionId)
KaleoDefinition	fetchKaleoDefinition(java.lang.String name, ServiceContext serviceContext)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
KaleoDefinition	getKaleoDefinition(long kaleoDefinitionId) Returns the kaleo definition with the primary key.
KaleoDefinition	getKaleoDefinition(java.lang.String name, ServiceContext serviceContext)
java.util.List<KaleoDefinition>	getKaleoDefinitions(boolean active, int start, int end, OrderByComparator<KaleoDefinition> orderByComparator, ServiceContext serviceContext)
java.util.List<KaleoDefinition>	getKaleoDefinitions(int start, int end) Returns a range of all the kaleo definitions.
java.util.List<KaleoDefinition>	getKaleoDefinitions(int start, int end, OrderByComparator<KaleoDefinition> orderByComparator, ServiceContext serviceContext)
int	getKaleoDefinitionsCount() Returns the number of kaleo definitions.
int	getKaleoDefinitionsCount(boolean active, ServiceContext serviceContext)
int	getKaleoDefinitionsCount(ServiceContext serviceContext)
int	getKaleoDefinitionsCount(java.lang.String name, boolean active, ServiceContext serviceContext)
int	getKaleoDefinitionsCount(java.lang.String name, ServiceContext serviceContext)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
KaleoDefinition	updatedKaleoDefinition(long kaleoDefinitionId, java.lang.String title, java.lang.String description, java.lang.String content, ServiceContext serviceContext)
KaleoDefinition	updateKaleoDefinition(KaleoDefinition kaleoDefinition) Updates the kaleo definition 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

activateKaleoDefinition

void activateKaleoDefinition(long kaleoDefinitionId,
                             long kaleoDefinitionVersionId,
                             long startKaleoNodeId,
                             ServiceContext serviceContext)
                      throws PortalException

Throws:

PortalException

activateKaleoDefinition

void activateKaleoDefinition(long kaleoDefinitionId,
                             ServiceContext serviceContext)
                      throws PortalException

Throws:

PortalException

activateKaleoDefinition

void activateKaleoDefinition(java.lang.String name,
                             int version,
                             ServiceContext serviceContext)
                      throws PortalException

Throws:

PortalException

addKaleoDefinition

@Indexable(type=REINDEX)
KaleoDefinition addKaleoDefinition(KaleoDefinition kaleoDefinition)

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

Parameters:

kaleoDefinition - the kaleo definition

Returns:

the kaleo definition that was added

addKaleoDefinition

@Deprecated
KaleoDefinition addKaleoDefinition(java.lang.String name,
                                               java.lang.String title,
                                               java.lang.String description,
                                               java.lang.String content,
                                               int version,
                                               ServiceContext serviceContext)
                                        throws PortalException

Deprecated. As of Athanasius (7.3.x), replaced by addKaleoDefinition(String, String, String, String, String, int, ServiceContext)

Throws:

PortalException

addKaleoDefinition

KaleoDefinition addKaleoDefinition(java.lang.String name,
                                   java.lang.String title,
                                   java.lang.String description,
                                   java.lang.String content,
                                   java.lang.String scope,
                                   int version,
                                   ServiceContext serviceContext)
                            throws PortalException

Throws:

PortalException

createKaleoDefinition

@Transactional(enabled=false)
KaleoDefinition createKaleoDefinition(long kaleoDefinitionId)

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

Parameters:

kaleoDefinitionId - the primary key for the new kaleo definition

Returns:

the new kaleo definition

createPersistedModel

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

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deactivateKaleoDefinition

void deactivateKaleoDefinition(java.lang.String name,
                               int version,
                               ServiceContext serviceContext)
                        throws PortalException

Throws:

PortalException

deleteCompanyKaleoDefinitions

void deleteCompanyKaleoDefinitions(long companyId)

deleteKaleoDefinition

@Indexable(type=DELETE)
KaleoDefinition deleteKaleoDefinition(KaleoDefinition kaleoDefinition)

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

Parameters:

kaleoDefinition - the kaleo definition

Returns:

the kaleo definition that was removed

deleteKaleoDefinition

@Indexable(type=DELETE)
KaleoDefinition deleteKaleoDefinition(long kaleoDefinitionId)
                                                       throws PortalException

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

Parameters:

kaleoDefinitionId - the primary key of the kaleo definition

Returns:

the kaleo definition that was removed

Throws:

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

deleteKaleoDefinition

void deleteKaleoDefinition(java.lang.String name,
                           ServiceContext serviceContext)
                    throws PortalException

Throws:

PortalException

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

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

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

fetchKaleoDefinition

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KaleoDefinition fetchKaleoDefinition(long kaleoDefinitionId)

fetchKaleoDefinition

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KaleoDefinition fetchKaleoDefinition(java.lang.String name,
                                                                                                        ServiceContext serviceContext)

getActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

getKaleoDefinition

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KaleoDefinition getKaleoDefinition(long kaleoDefinitionId)
                                                                                               throws PortalException

Returns the kaleo definition with the primary key.

Parameters:

kaleoDefinitionId - the primary key of the kaleo definition

Returns:

the kaleo definition

Throws:

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

getKaleoDefinition

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KaleoDefinition getKaleoDefinition(java.lang.String name,
                                                                                                      ServiceContext serviceContext)
                                                                                               throws PortalException

Throws:

PortalException

getKaleoDefinitions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KaleoDefinition> getKaleoDefinitions(boolean active,
                                                                                                                       int start,
                                                                                                                       int end,
                                                                                                                       OrderByComparator<KaleoDefinition> orderByComparator,
                                                                                                                       ServiceContext serviceContext)

getKaleoDefinitions

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

Returns a range of all the kaleo definitions.

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

Parameters:

start - the lower bound of the range of kaleo definitions

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

Returns:

the range of kaleo definitions

getKaleoDefinitions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KaleoDefinition> getKaleoDefinitions(int start,
                                                                                                                       int end,
                                                                                                                       OrderByComparator<KaleoDefinition> orderByComparator,
                                                                                                                       ServiceContext serviceContext)

getKaleoDefinitionsCount

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

Returns the number of kaleo definitions.

Returns:

the number of kaleo definitions

getKaleoDefinitionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKaleoDefinitionsCount(boolean active,
                                                                                                ServiceContext serviceContext)

getKaleoDefinitionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKaleoDefinitionsCount(ServiceContext serviceContext)

getKaleoDefinitionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKaleoDefinitionsCount(java.lang.String name,
                                                                                                boolean active,
                                                                                                ServiceContext serviceContext)

getKaleoDefinitionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKaleoDefinitionsCount(java.lang.String name,
                                                                                                ServiceContext serviceContext)

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

updatedKaleoDefinition

KaleoDefinition updatedKaleoDefinition(long kaleoDefinitionId,
                                       java.lang.String title,
                                       java.lang.String description,
                                       java.lang.String content,
                                       ServiceContext serviceContext)
                                throws PortalException

Throws:

PortalException

updateKaleoDefinition

@Indexable(type=REINDEX)
KaleoDefinition updateKaleoDefinition(KaleoDefinition kaleoDefinition)

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

Parameters:

kaleoDefinition - the kaleo definition

Returns:

the kaleo definition that was updated