info.magnolia.module.workflow
Class WorkflowUtil

java.lang.Object
  info.magnolia.module.workflow.WorkflowUtil

public class WorkflowUtil
extends java.lang.Object

Util to use the mangoila workflow module. Methods to launch and proceed.

Author:

jackie

Field Summary

static openwfe.org.engine.workitem.StringAttribute	ATTRIBUTE_FALSE
static openwfe.org.engine.workitem.StringAttribute	ATTRIBUTE_TRUE

Method Summary

static void	assignWorkItemToUser(openwfe.org.engine.workitem.InFlowWorkItem wi, java.lang.String userName) assign work item to a user, if userName = "", then assignment for the workItem will be deleted.
static void	assignWorkItemToUser(java.lang.String id, java.lang.String userName) assign work item to a user, if userName = "", then assignment for the workItem will be deleted.
static void	cancel(java.lang.String id, java.lang.String comment)
static java.util.List	getGroupInbox(java.lang.String GroupName) return a list of workItem for one group.
static java.lang.String	getId(openwfe.org.engine.workitem.InFlowItem wi)
static java.lang.String	getPath(java.lang.String id)
static java.util.List	getRoleInbox(java.lang.String roleName) return a list of workItem for one role.
static java.util.List	getUserInbox(java.lang.String userName) return a list of workItem for one user.
static openwfe.org.engine.workitem.InFlowWorkItem	getWorkItem(java.lang.String id) Retrieves a workitem by id.
static java.util.List	getWorkItems(java.lang.String userName) get all work items for the user.
static JCRWorkItemStore	getWorkItemStore()
static void	launchFlow(openwfe.org.engine.workitem.LaunchItem li)
static void	launchFlow(openwfe.org.engine.workitem.LaunchItem li, java.lang.String flowName) Start a flow.
static void	launchFlow(java.lang.String repository, java.lang.String path, java.lang.String flowName) Simply launch a flow for the specified node.
static void	proceed(openwfe.org.engine.workitem.InFlowWorkItem wi) Proceed this item.
static void	proceed(java.lang.String id)
static void	proceed(java.lang.String id, java.lang.String action)
static void	proceed(java.lang.String id, java.lang.String action, java.lang.String comment)
static void	reject(java.lang.String id, java.lang.String comment)

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_TRUE

public static final openwfe.org.engine.workitem.StringAttribute ATTRIBUTE_TRUE

ATTRIBUTE_FALSE

public static final openwfe.org.engine.workitem.StringAttribute ATTRIBUTE_FALSE

Method Detail

getWorkItemStore

public static JCRWorkItemStore getWorkItemStore()

launchFlow

public static void launchFlow(openwfe.org.engine.workitem.LaunchItem li)

launchFlow

public static void launchFlow(java.lang.String repository,
                              java.lang.String path,
                              java.lang.String flowName)
                       throws java.lang.Exception

Simply launch a flow for the specified node.

Throws:

java.lang.Exception

launchFlow

public static void launchFlow(openwfe.org.engine.workitem.LaunchItem li,
                              java.lang.String flowName)
                       throws FlowDefinitionException

Start a flow.

Parameters:

li - the prepared lunchItem

flowName - the flow to start

Throws:

FlowDefinitionException

proceed

public static void proceed(java.lang.String id)

proceed

public static void proceed(java.lang.String id,
                           java.lang.String action)

proceed

public static void proceed(java.lang.String id,
                           java.lang.String action,
                           java.lang.String comment)

reject

public static void reject(java.lang.String id,
                          java.lang.String comment)

cancel

public static void cancel(java.lang.String id,
                          java.lang.String comment)

proceed

public static void proceed(openwfe.org.engine.workitem.InFlowWorkItem wi)

Proceed this item.

Parameters:

wi -

getWorkItem

public static openwfe.org.engine.workitem.InFlowWorkItem getWorkItem(java.lang.String id)

Retrieves a workitem by id.

Parameters:

id - identifier for the workitem as stored in the engine

Returns:

InFlowWorkItem corresponding to the workitem

getPath

public static java.lang.String getPath(java.lang.String id)

getWorkItems

public static java.util.List getWorkItems(java.lang.String userName)
                                   throws java.lang.Exception

get all work items for the user.

Throws:

java.lang.Exception

getId

public static java.lang.String getId(openwfe.org.engine.workitem.InFlowItem wi)

assignWorkItemToUser

public static void assignWorkItemToUser(java.lang.String id,
                                        java.lang.String userName)

assign work item to a user, if userName = "", then assignment for the workItem will be deleted.

assignWorkItemToUser

public static void assignWorkItemToUser(openwfe.org.engine.workitem.InFlowWorkItem wi,
                                        java.lang.String userName)

assign work item to a user, if userName = "", then assignment for the workItem will be deleted.

getUserInbox

public static java.util.List getUserInbox(java.lang.String userName)
                                   throws java.lang.Exception

return a list of workItem for one user.

Throws:

java.lang.Exception

getGroupInbox

public static java.util.List getGroupInbox(java.lang.String GroupName)
                                    throws java.lang.Exception

return a list of workItem for one group.

Throws:

java.lang.Exception

getRoleInbox

public static java.util.List getRoleInbox(java.lang.String roleName)
                                   throws java.lang.Exception

return a list of workItem for one role.

Throws:

java.lang.Exception