@ProviderType
public class KaleoDraftDefinitionLocalServiceUtil
extends java.lang.Object
com.liferay.portal.workflow.kaleo.designer.service.impl.KaleoDraftDefinitionLocalServiceImpl
and is the
primary 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.KaleoDraftDefinitionLocalService
,
com.liferay.portal.workflow.kaleo.designer.service.base.KaleoDraftDefinitionLocalServiceBaseImpl
,
com.liferay.portal.workflow.kaleo.designer.service.impl.KaleoDraftDefinitionLocalServiceImpl
Constructor and Description |
---|
KaleoDraftDefinitionLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static KaleoDraftDefinition |
addKaleoDraftDefinition(KaleoDraftDefinition kaleoDraftDefinition)
Adds the kaleo draft definition to the database.
|
static KaleoDraftDefinition |
addKaleoDraftDefinition(long userId,
long groupId,
java.lang.String name,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.lang.String content,
int version,
int draftVersion,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a Kaleo draft definition.
|
static KaleoDraftDefinition |
createKaleoDraftDefinition(long kaleoDraftDefinitionId)
Creates a new kaleo draft definition with the primary key.
|
static KaleoDraftDefinition |
deleteKaleoDraftDefinition(KaleoDraftDefinition kaleoDraftDefinition)
Deletes the kaleo draft definition from the database.
|
static KaleoDraftDefinition |
deleteKaleoDraftDefinition(long kaleoDraftDefinitionId)
Deletes the kaleo draft definition with the primary key from the database.
|
static KaleoDraftDefinition |
deleteKaleoDraftDefinition(java.lang.String name,
int version,
int draftVersion,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deletes the Kaleo draft definition and its resources matching the name,
published version, and draft version.
|
static void |
deleteKaleoDraftDefinitions(java.lang.String name,
int version,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deletes the kaleo draft definition and its resources matching the name
and version.
|
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.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> java.util.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> java.util.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 KaleoDraftDefinition |
fetchKaleoDraftDefinition(long kaleoDraftDefinitionId) |
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static KaleoDraftDefinition |
getKaleoDraftDefinition(long kaleoDraftDefinitionId)
Returns the kaleo draft definition with the primary key.
|
static KaleoDraftDefinition |
getKaleoDraftDefinition(java.lang.String name,
int version,
int draftVersion,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Returns the Kaleo draft definition matching the name, published version,
and draft version.
|
static java.util.List<KaleoDraftDefinition> |
getKaleoDraftDefinitions(int start,
int end)
Returns a range of all the kaleo draft definitions.
|
static java.util.List<KaleoDraftDefinition> |
getKaleoDraftDefinitions(java.lang.String name,
int version,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Returns an ordered range of the Kaleo draft definitions matching the name
and version.
|
static int |
getKaleoDraftDefinitionsCount()
Returns the number of kaleo draft definitions.
|
static int |
getKaleoDraftDefinitionsCount(java.lang.String name,
int version,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Returns the number of Kaleo draft definition matching the name and
version.
|
static KaleoDraftDefinition |
getLatestKaleoDraftDefinition(java.lang.String name,
int version,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Returns the latest Kaleo draft definition matching the name and version.
|
static java.util.List<KaleoDraftDefinition> |
getLatestKaleoDraftDefinitions(long companyId,
int version,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
Returns an ordered range of the latest Kaleo draft definitions matching
the company and version.
|
static java.util.List<KaleoDraftDefinition> |
getLatestKaleoDraftDefinitions(long companyId,
java.lang.String keywords,
int version,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
Returns an ordered range of the latest Kaleo draft definitions matching
the company, keywords, and version.
|
static int |
getLatestKaleoDraftDefinitionsCount(long companyId,
int version)
Returns the number of Kaleo draft definitions matching the company and
version.
|
static int |
getLatestKaleoDraftDefinitionsCount(long companyId,
java.lang.String keywords,
int version)
Returns the number of Kaleo draft definitions matching the company,
keywords, and version.
|
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static KaleoDraftDefinitionLocalService |
getService() |
static KaleoDraftDefinition |
incrementKaleoDraftDefinitionDraftVersion(long userId,
java.lang.String name,
int version,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a Kaleo draft definition with a draft version increment.
|
static KaleoDraftDefinition |
publishKaleoDraftDefinition(long userId,
long groupId,
java.lang.String name,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.lang.String content,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Publishes the Kaleo draft definition.
|
static KaleoDraftDefinition |
updateKaleoDraftDefinition(KaleoDraftDefinition kaleoDraftDefinition)
Updates the kaleo draft definition in the database or adds it if it does not yet exist.
|
static KaleoDraftDefinition |
updateKaleoDraftDefinition(long userId,
java.lang.String name,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.lang.String content,
int version,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the Kaleo draft definition by replacing its content and title and
incrementing the draft version.
|
public KaleoDraftDefinitionLocalServiceUtil()
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
PortalException
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static KaleoDraftDefinition addKaleoDraftDefinition(KaleoDraftDefinition kaleoDraftDefinition)
kaleoDraftDefinition
- the kaleo draft definitionpublic static KaleoDraftDefinition addKaleoDraftDefinition(long userId, long groupId, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.lang.String content, int version, int draftVersion, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the Kaleo draft definition's
creator/ownergroupId
- the primary key of the Kaleo draft definition's groupname
- the Kaleo draft definition's nametitleMap
- the Kaleo draft definition's locales and localized
titlescontent
- the content wrapped in XMLversion
- the Kaleo draft definition's published versiondraftVersion
- the Kaleo draft definition's draft versionserviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo draft
definition.PortalException
- if a portal exception occurredpublic static KaleoDraftDefinition createKaleoDraftDefinition(long kaleoDraftDefinitionId)
kaleoDraftDefinitionId
- the primary key for the new kaleo draft definitionpublic static KaleoDraftDefinition deleteKaleoDraftDefinition(KaleoDraftDefinition kaleoDraftDefinition) throws com.liferay.portal.kernel.exception.PortalException
kaleoDraftDefinition
- the kaleo draft definitionPortalException
public static KaleoDraftDefinition deleteKaleoDraftDefinition(java.lang.String name, int version, int draftVersion, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
name
- the Kaleo draft definition's nameversion
- the Kaleo draft definition's published versiondraftVersion
- the Kaleo draft definition's draft versionserviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo draft
definition.PortalException
- if a portal exception occurredpublic static KaleoDraftDefinition deleteKaleoDraftDefinition(long kaleoDraftDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
kaleoDraftDefinitionId
- the primary key of the kaleo draft definitionPortalException
- if a kaleo draft definition with the primary key could not be foundpublic static KaleoDraftDefinition fetchKaleoDraftDefinition(long kaleoDraftDefinitionId)
public static KaleoDraftDefinition getKaleoDraftDefinition(java.lang.String name, int version, int draftVersion, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
name
- the Kaleo draft definition's nameversion
- the Kaleo draft definition's published versiondraftVersion
- the Kaleo draft definition's draft versionserviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo draft
definition.PortalException
- if a portal exception occurredpublic static KaleoDraftDefinition getKaleoDraftDefinition(long kaleoDraftDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
kaleoDraftDefinitionId
- the primary key of the kaleo draft definitionPortalException
- if a kaleo draft definition with the primary key could not be foundpublic static KaleoDraftDefinition getLatestKaleoDraftDefinition(java.lang.String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
name
- the Kaleo draft definition's nameversion
- the Kaleo draft definition's published versionserviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo draft
definition.PortalException
- if a matching Kaleo draft definition could not be
foundpublic static KaleoDraftDefinition incrementKaleoDraftDefinitionDraftVersion(long userId, java.lang.String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the Kaleo draft definition's
creator/ownername
- the Kaleo draft definition's nameversion
- the Kaleo draft definition's published versionserviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo draft
deifnition.PortalException
- if a portal exception occurredpublic static KaleoDraftDefinition publishKaleoDraftDefinition(long userId, long groupId, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.lang.String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the Kaleo draft definition's
creator/ownergroupId
- the primary key of the Kaleo draft definition's groupname
- the Kaleo draft definition's nametitleMap
- the Kaleo draft definition's locales and localized
titlescontent
- the content wrapped in XMLserviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo draft
definition.PortalException
- if the user did not have the required permissions
to publish the Kaleo draft definition or if a portal exception
occurredpublic static KaleoDraftDefinition updateKaleoDraftDefinition(KaleoDraftDefinition kaleoDraftDefinition)
kaleoDraftDefinition
- the kaleo draft definitionpublic static KaleoDraftDefinition updateKaleoDraftDefinition(long userId, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.lang.String content, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the Kaleo draft definition's
creator/ownername
- the Kaleo draft definition's nametitleMap
- the Kaleo draft definition's locales and localized
titlescontent
- the content wrapped in XMLversion
- the Kaleo draft definition's published versionserviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo draft
definition.PortalException
- if the user did not have the required permissions
to update the Kaleo draft definition or if a portal exception
occurredpublic static int getKaleoDraftDefinitionsCount()
public static int getKaleoDraftDefinitionsCount(java.lang.String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext)
name
- the Kaleo draft definition's nameversion
- the Kaleo draft definition's published versionserviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo draft
definition.public static int getLatestKaleoDraftDefinitionsCount(long companyId, int version)
companyId
- the primary key of the Kaleo draft definition's companyversion
- the Kaleo draft definition's published versionpublic static int getLatestKaleoDraftDefinitionsCount(long companyId, java.lang.String keywords, int version)
companyId
- the primary key of the Kaleo draft definition's companykeywords
- the Kaleo draft definition's name or titleversion
- the Kaleo draft definition's published versionpublic static java.lang.String getOSGiServiceIdentifier()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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 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 and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.portal.workflow.kaleo.designer.model.impl.KaleoDraftDefinitionModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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 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 and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.portal.workflow.kaleo.designer.model.impl.KaleoDraftDefinitionModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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 (optionally null
)public static java.util.List<KaleoDraftDefinition> getKaleoDraftDefinitions(int start, int end)
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 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 and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.portal.workflow.kaleo.designer.model.impl.KaleoDraftDefinitionModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start
- the lower bound of the range of kaleo draft definitionsend
- the upper bound of the range of kaleo draft definitions (not inclusive)public static java.util.List<KaleoDraftDefinition> getKaleoDraftDefinitions(java.lang.String name, int version, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
name
- the Kaleo draft definition's nameversion
- the Kaleo draft definition's published versionstart
- the lower bound of the range of Kaleo draft definitions to
returnend
- the upper bound of the range of Kaleo draft definitions to
return (not inclusive)orderByComparator
- the comparator to order the Kaleo draft
definitionsserviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo draft
definition.public static java.util.List<KaleoDraftDefinition> getLatestKaleoDraftDefinitions(long companyId, int version, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
companyId
- the primary key of the Kaleo draft definition's companyversion
- the Kaleo draft definition's published versionstart
- the lower bound of the range of Kaleo draft definitions to
returnend
- the upper bound of the range of Kaleo draft definitions to
return (not inclusive)orderByComparator
- the comparator to order the Kaleo draft
definitionspublic static java.util.List<KaleoDraftDefinition> getLatestKaleoDraftDefinitions(long companyId, java.lang.String keywords, int version, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
companyId
- the primary key of the Kaleo draft definition's companykeywords
- the Kaleo draft definition's name or titleversion
- the Kaleo draft definition's published versionstart
- the lower bound of the range of Kaleo draft definitions to
returnend
- the upper bound of the range of Kaleo draft definitions to
return (not inclusive)orderByComparator
- the comparator to order the Kaleo draft
definitionspublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static void deleteKaleoDraftDefinitions(java.lang.String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
name
- the Kaleo draft definition's nameversion
- the Kaleo draft definition's published versionserviceContext
- the service context to be applied. This can set
guest permissions and group permissions for the Kaleo draft
definition.PortalException
- if a portal exception occurredpublic static KaleoDraftDefinitionLocalService getService()