com.liferay.portal.workflow.kaleo.designer.service

Interface KaleoDraftDefinitionService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseService

All Known Implementing Classes:

KaleoDraftDefinitionServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface KaleoDraftDefinitionService
extends com.liferay.portal.kernel.service.BaseService

Provides the remote service interface for KaleoDraftDefinition. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

KaleoDraftDefinitionServiceUtil, com.liferay.portal.workflow.kaleo.designer.service.base.KaleoDraftDefinitionServiceBaseImpl, com.liferay.portal.workflow.kaleo.designer.service.impl.KaleoDraftDefinitionServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
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.
void	deleteKaleoDraftDefinitions(java.lang.String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deletes the Kaleo draft definition and its resources.
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.
java.util.List<KaleoDraftDefinition>	getKaleoDraftDefinitions() Returns the Kaleo draft definitions.
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.
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.
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.
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
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.
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.

Method Detail

addKaleoDraftDefinition

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

Adds a Kaleo draft definition.

Parameters:

userId - the primary key of the Kaleo draft definition's creator/owner

groupId - the primary key of the Kaleo draft definition's group

name - the Kaleo draft definition's name

titleMap - the Kaleo draft definition's locales and localized titles

content - the content wrapped in XML

version - the Kaleo draft definition's published version

draftVersion - the Kaleo draft definition's draft version

serviceContext - the service context to be applied. This can set guest permissions and group permissions for the Kaleo draft definition.

Returns:

the Kaleo draft definition

Throws:

com.liferay.portal.kernel.exception.PortalException - if the user did not have the required permissions to create the Kaleo draft definition or if a portal exception occurred

getKaleoDraftDefinition

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KaleoDraftDefinition getKaleoDraftDefinition(java.lang.String name,
                                                                                                                int version,
                                                                                                                int draftVersion,
                                                                                                                com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Returns the Kaleo draft definition matching the name, published version, and draft version.

Parameters:

name - the Kaleo draft definition's name

version - the Kaleo draft definition's published version

draftVersion - the Kaleo draft definition's draft version

serviceContext - the service context to be applied. This can set guest permissions and group permissions for the Kaleo draft definition.

Returns:

the matching Kaleo draft definition

Throws:

com.liferay.portal.kernel.exception.PortalException - if the user did not have the required permissions to access the Kaleo draft definition or if a portal exception occurred

getLatestKaleoDraftDefinition

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KaleoDraftDefinition getLatestKaleoDraftDefinition(java.lang.String name,
                                                                                                                      int version,
                                                                                                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Returns the latest Kaleo draft definition matching the name and version.

Parameters:

name - the Kaleo draft definition's name

version - the Kaleo draft definition's published version

serviceContext - the service context to be applied. This can set guest permissions and group permissions for the Kaleo draft definition.

Returns:

the latest matching Kaleo draft definition

Throws:

com.liferay.portal.kernel.exception.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 definition

publishKaleoDraftDefinition

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

Publishes the Kaleo draft definition.

Parameters:

userId - the primary key of the Kaleo draft definition's creator/owner

groupId - the primary key of the Kaleo draft definition's group

name - the Kaleo draft definition's name

titleMap - the Kaleo draft definition's locales and localized titles

content - the content wrapped in XML

serviceContext - the service context to be applied. This can set guest permissions and group permissions for the Kkaleo draft definition.

Returns:

the published Kaleo draft definition

Throws:

com.liferay.portal.kernel.exception.PortalException - if the user did not have the required permissions to publish the Kaleo draft definition or if a portal exception occurred

updateKaleoDraftDefinition

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

Updates the Kaleo draft definition by replacing its content and title and incrementing the draft version.

Parameters:

userId - the primary key of the Kaleo draft definition's creator/owner

name - the Kaleo draft definition's name

titleMap - the Kaleo draft definition's locales and localized titles

content - the content wrapped in XML

version - the Kaleo draft definition's published version

serviceContext - the service context to be applied. This can set guest permissions and group permissions for the Kaleo draft definition.

Returns:

the updated Kaleo draft definition

Throws:

com.liferay.portal.kernel.exception.PortalException - if the user did not have the required permissions to update the Kaleo draft definition or if a portal exception occurred

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getKaleoDraftDefinitions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KaleoDraftDefinition> getKaleoDraftDefinitions()
                                                                                                                          throws com.liferay.portal.kernel.exception.PortalException

Returns the Kaleo draft definitions.

Returns:

the Kaleo draft definitions

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getLatestKaleoDraftDefinitions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

Returns an ordered range of the latest Kaleo draft definitions matching the company and version.

Parameters:

companyId - the primary key of the Kaleo draft definition's company

version - the Kaleo draft definition's published version

start - the lower bound of the range of Kaleo draft definitions to return

end - the upper bound of the range of Kkaleo draft definitions to return (not inclusive)

orderByComparator - the comparator to order the Kaleo draft definitions

Returns:

the range of matching Kaleo draft definitions ordered by the comparator

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getLatestKaleoDraftDefinitions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

Returns an ordered range of the latest Kaleo draft definitions matching the company, version, and keywords.

Parameters:

companyId - the primary key of the Kaleo draft definition's company

keywords - the Kaleo draft definition's name or title

version - the Kaleo draft definition's published version

start - the lower bound of the range of Kaleo draft definitions to return

end - the upper bound of the range of Kaleo draft definitions to return (not inclusive)

orderByComparator - the comparator to order the Kaleo draft definitions

Returns:

the range of matching Kaleo draft definitions ordered by the comparator

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

deleteKaleoDraftDefinitions

void deleteKaleoDraftDefinitions(java.lang.String name,
                                 int version,
                                 com.liferay.portal.kernel.service.ServiceContext serviceContext)
                          throws com.liferay.portal.kernel.exception.PortalException

Deletes the Kaleo draft definition and its resources.

Parameters:

name - the Kaleo draft definition's name

version - the Kaleo draft definition's published version

serviceContext - the service context to be applied. This can set guest permissions and group permissions for the Kaleo draft definition.

Throws:

com.liferay.portal.kernel.exception.PortalException - if the user did not have the required permissions to delete the Kaleo draft definition or if a portal exception occurred