Class KaleoDefinitionLocalServiceUtil
com.liferay.portal.workflow.kaleo.service.impl.KaleoDefinitionLocalServiceImpl
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:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic KaleoDefinition
activateKaleoDefinition
(long kaleoDefinitionId, long kaleoDefinitionVersionId, long startKaleoNodeId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KaleoDefinition
activateKaleoDefinition
(long kaleoDefinitionId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KaleoDefinition
activateKaleoDefinition
(String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KaleoDefinition
addKaleoDefinition
(KaleoDefinition kaleoDefinition) Adds the kaleo definition to the database.static KaleoDefinition
addKaleoDefinition
(String externalReferenceCode, String name, String title, String description, String content, String scope, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KaleoDefinition
createKaleoDefinition
(long kaleoDefinitionId) Creates a new kaleo definition with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static KaleoDefinition
deactivateKaleoDefinition
(String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) static void
deleteCompanyKaleoDefinitions
(long companyId) static KaleoDefinition
deleteKaleoDefinition
(long kaleoDefinitionId) Deletes the kaleo definition with the primary key from the database.static KaleoDefinition
deleteKaleoDefinition
(KaleoDefinition kaleoDefinition) Deletes the kaleo definition from the database.static void
deleteKaleoDefinition
(String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static 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.static KaleoDefinition
fetchKaleoDefinition
(long kaleoDefinitionId) static KaleoDefinition
fetchKaleoDefinition
(String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KaleoDefinition
fetchKaleoDefinitionByExternalReferenceCode
(String externalReferenceCode, long companyId) static KaleoDefinition
fetchKaleoDefinitionByUuidAndGroupId
(String uuid, long groupId) Returns the kaleo definition matching the UUID and group.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static KaleoDefinition
getKaleoDefinition
(long kaleoDefinitionId) Returns the kaleo definition with the primary key.static KaleoDefinition
getKaleoDefinition
(String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KaleoDefinition
getKaleoDefinitionByExternalReferenceCode
(String externalReferenceCode, long companyId) static KaleoDefinition
getKaleoDefinitionByUuidAndGroupId
(String uuid, long groupId) Returns the kaleo definition matching the UUID and group.static List<KaleoDefinition>
getKaleoDefinitions
(boolean active, int start, int end) static List<KaleoDefinition>
getKaleoDefinitions
(boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoDefinition> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) static List<KaleoDefinition>
getKaleoDefinitions
(int start, int end) Returns a range of all the kaleo definitions.static List<KaleoDefinition>
getKaleoDefinitions
(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoDefinition> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) static List<KaleoDefinition>
getKaleoDefinitionsByUuidAndCompanyId
(String uuid, long companyId) Returns all the kaleo definitions matching the UUID and company.static List<KaleoDefinition>
getKaleoDefinitionsByUuidAndCompanyId
(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoDefinition> orderByComparator) Returns a range of kaleo definitions matching the UUID and company.static int
Returns the number of kaleo definitions.static int
getKaleoDefinitionsCount
(boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext) static int
getKaleoDefinitionsCount
(com.liferay.portal.kernel.service.ServiceContext serviceContext) static int
getKaleoDefinitionsCount
(String name, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext) static int
getKaleoDefinitionsCount
(String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static List<KaleoDefinition>
getScopeKaleoDefinitions
(String scope, boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoDefinition> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) static List<KaleoDefinition>
getScopeKaleoDefinitions
(String scope, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoDefinition> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) static int
getScopeKaleoDefinitionsCount
(String scope, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext) static int
getScopeKaleoDefinitionsCount
(String scope, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KaleoDefinitionLocalService
static KaleoDefinition
updatedKaleoDefinition
(String externalReferenceCode, long kaleoDefinitionId, String title, String description, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KaleoDefinition
updateKaleoDefinition
(KaleoDefinition kaleoDefinition) Updates the kaleo definition in the database or adds it if it does not yet exist.
-
Constructor Details
-
KaleoDefinitionLocalServiceUtil
public KaleoDefinitionLocalServiceUtil()
-
-
Method Details
-
activateKaleoDefinition
public static KaleoDefinition activateKaleoDefinition(long kaleoDefinitionId, long kaleoDefinitionVersionId, long startKaleoNodeId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
activateKaleoDefinition
public static KaleoDefinition activateKaleoDefinition(long kaleoDefinitionId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
activateKaleoDefinition
public static KaleoDefinition activateKaleoDefinition(String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addKaleoDefinition
Adds the kaleo definition to the database. Also notifies the appropriate model listeners.Important: Inspect KaleoDefinitionLocalServiceImpl 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:
kaleoDefinition
- the kaleo definition- Returns:
- the kaleo definition that was added
-
addKaleoDefinition
public static KaleoDefinition addKaleoDefinition(String externalReferenceCode, String name, String title, String description, String content, String scope, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createKaleoDefinition
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
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deactivateKaleoDefinition
public static KaleoDefinition deactivateKaleoDefinition(String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteCompanyKaleoDefinitions
public static void deleteCompanyKaleoDefinitions(long companyId) -
deleteKaleoDefinition
Deletes the kaleo definition from the database. Also notifies the appropriate model listeners.Important: Inspect KaleoDefinitionLocalServiceImpl 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:
kaleoDefinition
- the kaleo definition- Returns:
- the kaleo definition that was removed
-
deleteKaleoDefinition
public static KaleoDefinition deleteKaleoDefinition(long kaleoDefinitionId) throws com.liferay.portal.kernel.exception.PortalException Deletes the kaleo definition with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect KaleoDefinitionLocalServiceImpl 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:
kaleoDefinitionId
- the primary key of the kaleo definition- Returns:
- the kaleo definition that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a kaleo definition with the primary key could not be found
-
deleteKaleoDefinition
public static void deleteKaleoDefinition(String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.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> 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.workflow.kaleo.model.impl.KaleoDefinitionModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.workflow.kaleo.model.impl.KaleoDefinitionModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public static 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
public static 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 queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchKaleoDefinition
-
fetchKaleoDefinition
public static KaleoDefinition fetchKaleoDefinition(String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
fetchKaleoDefinitionByExternalReferenceCode
public static KaleoDefinition fetchKaleoDefinitionByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchKaleoDefinitionByUuidAndGroupId
Returns the kaleo definition matching the UUID and group.- Parameters:
uuid
- the kaleo definition's UUIDgroupId
- the primary key of the group- Returns:
- the matching kaleo definition, or
null
if a matching kaleo definition could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getKaleoDefinition
public static KaleoDefinition getKaleoDefinition(long kaleoDefinitionId) throws com.liferay.portal.kernel.exception.PortalException Returns the kaleo definition with the primary key.- Parameters:
kaleoDefinitionId
- the primary key of the kaleo definition- Returns:
- the kaleo definition
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a kaleo definition with the primary key could not be found
-
getKaleoDefinition
public static KaleoDefinition getKaleoDefinition(String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKaleoDefinitionByExternalReferenceCode
public static KaleoDefinition getKaleoDefinitionByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKaleoDefinitionByUuidAndGroupId
public static KaleoDefinition getKaleoDefinitionByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the kaleo definition matching the UUID and group.- Parameters:
uuid
- the kaleo definition's UUIDgroupId
- the primary key of the group- Returns:
- the matching kaleo definition
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching kaleo definition could not be found
-
getKaleoDefinitions
-
getKaleoDefinitions
public static List<KaleoDefinition> getKaleoDefinitions(boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoDefinition> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
getKaleoDefinitions
Returns a range of all the kaleo definitions.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.workflow.kaleo.model.impl.KaleoDefinitionModelImpl
.- Parameters:
start
- the lower bound of the range of kaleo definitionsend
- the upper bound of the range of kaleo definitions (not inclusive)- Returns:
- the range of kaleo definitions
-
getKaleoDefinitions
public static List<KaleoDefinition> getKaleoDefinitions(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoDefinition> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
getKaleoDefinitionsByUuidAndCompanyId
public static List<KaleoDefinition> getKaleoDefinitionsByUuidAndCompanyId(String uuid, long companyId) Returns all the kaleo definitions matching the UUID and company.- Parameters:
uuid
- the UUID of the kaleo definitionscompanyId
- the primary key of the company- Returns:
- the matching kaleo definitions, or an empty list if no matches were found
-
getKaleoDefinitionsByUuidAndCompanyId
public static List<KaleoDefinition> getKaleoDefinitionsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoDefinition> orderByComparator) Returns a range of kaleo definitions matching the UUID and company.- Parameters:
uuid
- the UUID of the kaleo definitionscompanyId
- the primary key of the companystart
- the lower bound of the range of kaleo definitionsend
- the upper bound of the range of kaleo definitions (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching kaleo definitions, or an empty list if no matches were found
-
getKaleoDefinitionsCount
public static int getKaleoDefinitionsCount()Returns the number of kaleo definitions.- Returns:
- the number of kaleo definitions
-
getKaleoDefinitionsCount
public static int getKaleoDefinitionsCount(boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
getKaleoDefinitionsCount
public static int getKaleoDefinitionsCount(com.liferay.portal.kernel.service.ServiceContext serviceContext) -
getKaleoDefinitionsCount
public static int getKaleoDefinitionsCount(String name, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
getKaleoDefinitionsCount
public static int getKaleoDefinitionsCount(String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getScopeKaleoDefinitions
public static List<KaleoDefinition> getScopeKaleoDefinitions(String scope, boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoDefinition> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
getScopeKaleoDefinitions
public static List<KaleoDefinition> getScopeKaleoDefinitions(String scope, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KaleoDefinition> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
getScopeKaleoDefinitionsCount
public static int getScopeKaleoDefinitionsCount(String scope, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
getScopeKaleoDefinitionsCount
public static int getScopeKaleoDefinitionsCount(String scope, com.liferay.portal.kernel.service.ServiceContext serviceContext) -
updatedKaleoDefinition
public static KaleoDefinition updatedKaleoDefinition(String externalReferenceCode, long kaleoDefinitionId, String title, String description, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKaleoDefinition
Updates the kaleo definition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect KaleoDefinitionLocalServiceImpl 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:
kaleoDefinition
- the kaleo definition- Returns:
- the kaleo definition that was updated
-
getService
-