com.liferay.portal.kernel.workflow

Interface WorkflowHandler<T>

All Known Implementing Classes:

BaseWorkflowHandler

public interface WorkflowHandler<T>

Author:

Bruno Farache, Macerllus Tavares, Juan Fernández, Julio Camarero

Method Summary

Modifier and Type	Method and Description
AssetRenderer<T>	getAssetRenderer(long classPK)
AssetRendererFactory<T>	getAssetRendererFactory()
java.lang.String	getClassName()
java.lang.String	getIconCssClass()
java.lang.String	getIconPath(LiferayPortletRequest liferayPortletRequest) Deprecated. As of 7.0.0, with no direct replacement
java.lang.String	getSummary(long classPK, java.util.Locale locale) Deprecated. As of 7.0.0, replaced by getSummary(long, PortletRequest, PortletResponse)
java.lang.String	getSummary(long classPK, javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse)
java.lang.String	getTitle(long classPK, java.util.Locale locale)
java.lang.String	getType(java.util.Locale locale)
javax.portlet.PortletURL	getURLEdit(long classPK, LiferayPortletRequest liferayPortletRequest, LiferayPortletResponse liferayPortletResponse)
java.lang.String	getURLEditWorkflowTask(long workflowTaskId, ServiceContext serviceContext)
javax.portlet.PortletURL	getURLViewDiffs(long classPK, LiferayPortletRequest liferayPortletRequest, LiferayPortletResponse liferayPortletResponse)
java.lang.String	getURLViewInContext(long classPK, LiferayPortletRequest liferayPortletRequest, LiferayPortletResponse liferayPortletResponse, java.lang.String noSuchEntryRedirect)
WorkflowDefinitionLink	getWorkflowDefinitionLink(long companyId, long groupId, long classPK)
boolean	include(long classPK, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String template)
boolean	isAssetTypeSearchable()
boolean	isScopeable()
boolean	isVisible()
void	startWorkflowInstance(long companyId, long groupId, long userId, long classPK, T model, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
T	updateStatus(int status, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)

Method Detail

getAssetRenderer

AssetRenderer<T> getAssetRenderer(long classPK)
                           throws PortalException

Throws:

PortalException

getAssetRendererFactory

AssetRendererFactory<T> getAssetRendererFactory()

getClassName

java.lang.String getClassName()

getIconCssClass

java.lang.String getIconCssClass()

getIconPath

@Deprecated
java.lang.String getIconPath(LiferayPortletRequest liferayPortletRequest)

Deprecated. As of 7.0.0, with no direct replacement

getSummary

@Deprecated
java.lang.String getSummary(long classPK,
                                        java.util.Locale locale)

Deprecated. As of 7.0.0, replaced by getSummary(long, PortletRequest, PortletResponse)

getSummary

java.lang.String getSummary(long classPK,
                            javax.portlet.PortletRequest portletRequest,
                            javax.portlet.PortletResponse portletResponse)

getTitle

java.lang.String getTitle(long classPK,
                          java.util.Locale locale)

getType

java.lang.String getType(java.util.Locale locale)

getURLEdit

javax.portlet.PortletURL getURLEdit(long classPK,
                                    LiferayPortletRequest liferayPortletRequest,
                                    LiferayPortletResponse liferayPortletResponse)

getURLEditWorkflowTask

java.lang.String getURLEditWorkflowTask(long workflowTaskId,
                                        ServiceContext serviceContext)
                                 throws PortalException

Throws:

PortalException

getURLViewDiffs

javax.portlet.PortletURL getURLViewDiffs(long classPK,
                                         LiferayPortletRequest liferayPortletRequest,
                                         LiferayPortletResponse liferayPortletResponse)

getURLViewInContext

java.lang.String getURLViewInContext(long classPK,
                                     LiferayPortletRequest liferayPortletRequest,
                                     LiferayPortletResponse liferayPortletResponse,
                                     java.lang.String noSuchEntryRedirect)

getWorkflowDefinitionLink

WorkflowDefinitionLink getWorkflowDefinitionLink(long companyId,
                                                 long groupId,
                                                 long classPK)
                                          throws PortalException

Throws:

PortalException

include

boolean include(long classPK,
                javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response,
                java.lang.String template)

isAssetTypeSearchable

boolean isAssetTypeSearchable()

isScopeable

boolean isScopeable()

isVisible

boolean isVisible()

startWorkflowInstance

void startWorkflowInstance(long companyId,
                           long groupId,
                           long userId,
                           long classPK,
                           T model,
                           java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                    throws PortalException

Throws:

PortalException

updateStatus

T updateStatus(int status,
               java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
        throws PortalException

Throws:

PortalException