com.liferay.portal.workflow.kaleo.designer.util

Class KaleoDesignerUtil

java.lang.Object

com.liferay.portal.workflow.kaleo.designer.util.KaleoDesignerUtil

public class KaleoDesignerUtil
extends java.lang.Object

Provides utility methods used by Kaleo designer applications.

Constructor Summary

Constructors

Constructor and Description
KaleoDesignerUtil()

Method Summary

Modifier and Type	Method and Description
static KaleoDraftDefinition	addMissingKaleoDraftDefinition(java.lang.String name, int version, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.lang.String content, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static KaleoDraftDefinition	addMissingKaleoDraftDefinition(java.lang.String name, int version, java.lang.String title, java.lang.String content, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.portal.kernel.workflow.WorkflowDefinition	deployWorkflowDefinition(long companyId, long userId, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.lang.String content) Deploys the workflow definition.
static KaleoDraftDefinition	getKaleoDraftDefinition(javax.servlet.http.HttpServletRequest request) Returns the Kaleo draft definition, or creates one if it does not exist.
static KaleoDraftDefinition	getKaleoDraftDefinition(javax.portlet.PortletRequest portletRequest) Returns the Kaleo draft definition, or creates one if it does not exist.
static boolean	isPublished(KaleoDraftDefinition kaleoDraftDefinition) Returns true if the Kaleo draft definition is published.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KaleoDesignerUtil

public KaleoDesignerUtil()

Method Detail

addMissingKaleoDraftDefinition

public static KaleoDraftDefinition addMissingKaleoDraftDefinition(java.lang.String name,
                                                                  int version,
                                                                  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

Throws:

com.liferay.portal.kernel.exception.PortalException

addMissingKaleoDraftDefinition

public static KaleoDraftDefinition addMissingKaleoDraftDefinition(java.lang.String name,
                                                                  int version,
                                                                  java.lang.String title,
                                                                  java.lang.String content,
                                                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deployWorkflowDefinition

public static com.liferay.portal.kernel.workflow.WorkflowDefinition deployWorkflowDefinition(long companyId,
                                                                                             long userId,
                                                                                             java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                                                                             java.lang.String content)
                                                                                      throws com.liferay.portal.kernel.workflow.WorkflowException

Deploys the workflow definition.

Parameters:

companyId - the primary key of the workflow definition's company

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

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

content - the content wrapped in XML

Returns:

the workflow definition

Throws:

com.liferay.portal.kernel.workflow.WorkflowException - if a workflow exception occurred

getKaleoDraftDefinition

public static KaleoDraftDefinition getKaleoDraftDefinition(javax.servlet.http.HttpServletRequest request)
                                                    throws java.lang.Exception

Returns the Kaleo draft definition, or creates one if it does not exist.

Parameters:

request - the servlet request from which to read the parameters

Returns:

the Kaleo draft definition

Throws:

java.lang.Exception - if an exception occurred

getKaleoDraftDefinition

public static KaleoDraftDefinition getKaleoDraftDefinition(javax.portlet.PortletRequest portletRequest)
                                                    throws java.lang.Exception

Returns the Kaleo draft definition, or creates one if it does not exist.

Parameters:

portletRequest - the portlet request from which to read the parameters

Returns:

the Kaleo draft definition

Throws:

java.lang.Exception - if an exception occurred

isPublished

public static boolean isPublished(KaleoDraftDefinition kaleoDraftDefinition)

Returns true if the Kaleo draft definition is published.

Parameters:

kaleoDraftDefinition - the Kaleo draft definition

Returns:

true if the Kaleo draft definition is published; false otherwise