@ProviderType
public class KaleoDraftDefinitionServiceUtil
extends java.lang.Object
com.liferay.portal.workflow.kaleo.designer.service.impl.KaleoDraftDefinitionServiceImpl
and is the
primary access point for service operations in application layer code running
on a remote server. Methods of this service are expected to have security
checks based on the propagated JAAS credentials because this service can be
accessed remotely.KaleoDraftDefinitionService
,
com.liferay.portal.workflow.kaleo.designer.service.base.KaleoDraftDefinitionServiceBaseImpl
,
com.liferay.portal.workflow.kaleo.designer.service.impl.KaleoDraftDefinitionServiceImpl
Constructor and Description |
---|
KaleoDraftDefinitionServiceUtil() |
Modifier and Type | Method and Description |
---|---|
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 void |
deleteKaleoDraftDefinitions(java.lang.String name,
int version,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deletes the Kaleo draft definition and its resources.
|
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()
Returns the Kaleo draft definitions.
|
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, version, and keywords.
|
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static KaleoDraftDefinitionService |
getService() |
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(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 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 the user did not have the required permissions
to create the Kaleo draft definition or if a portal exception
occurredpublic 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 the user did not have the required permissions
to access the Kaleo draft definition or if a portal exception
occurredpublic 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
found or if the user did not have the required permissions to
access the Kaleo draft definitionpublic 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 Kkaleo 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(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 java.lang.String getOSGiServiceIdentifier()
public static java.util.List<KaleoDraftDefinition> getKaleoDraftDefinitions() throws com.liferay.portal.kernel.exception.PortalException
PortalException
- if a portal exception occurredpublic static java.util.List<KaleoDraftDefinition> getLatestKaleoDraftDefinitions(long companyId, int version, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
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 Kkaleo draft definitions to
return (not inclusive)orderByComparator
- the comparator to order the Kaleo draft
definitionsPortalException
- if a portal exception occurredpublic 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) throws com.liferay.portal.kernel.exception.PortalException
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
definitionsPortalException
- if a portal exception occurredpublic 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 the user did not have the required permissions
to delete the Kaleo draft definition or if a portal exception
occurredpublic static KaleoDraftDefinitionService getService()