Package com.vdoc.sdk.commons.ui.utils

Class NavigatorUtils

java.lang.Object

com.vdoc.sdk.commons.ui.utils.NavigatorUtils

public class NavigatorUtils
extends Object

Navigator utility class

Author:

vmartinon

Method Summary

Modifier and Type	Method	Description
static com.axemble.vdp.ui.framework.composites.base.CtlAbstractView	findFormEmbeddedView(String classs, String method)	This method can only be used in UI context of a process form Its aim is to get embedded views widget and so provider if needed (getProvider() on CtlAbstractView)
static IResource	getCurrentResource(IWorkflowModule workflowModule)	Method used to get current resource in which our screen is included.
protected static IResource	getCurrentResource(IWorkflowModule workflowModule, com.axemble.vdp.ui.framework.foundation.Navigator navigator)	Gets the current resource of a Navigator
static IWorkflowInstance	getCurrentWorkflowInstance(IWorkflowModule workflowModule)	Find current Workflow instance
static com.axemble.vdp.ui.framework.document.AbstractDocument	getDocumentByNavigatorId(String navigatorId)	Get the abstract document by a Navigator ID
static IWorkflowInstance	getWorkflowInstanceByNavigatorId(String navigatorId, IWorkflowModule iWorkflowModule)	Get the workflow instance by a Navigator ID

Methods inherited from class java.lang.Object

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

Method Details

getCurrentResource

public static IResource getCurrentResource(IWorkflowModule workflowModule)

Method used to get current resource in which our screen is included. Example : you include a view screen in a workflow form : in view provider, you need to use your workflow instance you're included in

Parameters:

workflowModule - the workflow module

Returns:

the current resource

getCurrentResource

protected static IResource getCurrentResource(IWorkflowModule workflowModule,
 com.axemble.vdp.ui.framework.foundation.Navigator navigator)
                                       throws NoSuchMethodException,
SecurityException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
WorkflowModuleException

Gets the current resource of a Navigator

Parameters:

workflowModule - the workflow module

navigator - the navigator

Returns:

the resource

Throws:

NoSuchMethodException - on error

SecurityException - on error

IllegalAccessException - on error

IllegalArgumentException - on error

InvocationTargetException - on error

WorkflowModuleException - on error

getCurrentWorkflowInstance

public static IWorkflowInstance getCurrentWorkflowInstance(IWorkflowModule workflowModule)

Find current Workflow instance

Parameters:

workflowModule - the workflow module

Returns:

the Workflow instance

See Also:

• getCurrentResource(IWorkflowModule)

findFormEmbeddedView

public static com.axemble.vdp.ui.framework.composites.base.CtlAbstractView findFormEmbeddedView(String classs,
 String method)

This method can only be used in UI context of a process form
Its aim is to get embedded views widget and so provider if needed (getProvider() on CtlAbstractView)

Parameters:

classs - Class name of screen

method - Method name of screen

Returns:

the widget of asked view

getWorkflowInstanceByNavigatorId

public static IWorkflowInstance getWorkflowInstanceByNavigatorId(String navigatorId,
 IWorkflowModule iWorkflowModule)
                                                          throws WorkflowModuleException,
NoSuchMethodException,
SecurityException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException

Get the workflow instance by a Navigator ID

Parameters:

navigatorId - the navigator id

iWorkflowModule - the workflow module

Returns:

the workflow instance

Throws:

InvocationTargetException - on error

IllegalArgumentException - on error

IllegalAccessException - on error

SecurityException - on error

NoSuchMethodException - on error

WorkflowModuleException - on error

getDocumentByNavigatorId

public static com.axemble.vdp.ui.framework.document.AbstractDocument getDocumentByNavigatorId(String navigatorId)
                                                                                       throws WorkflowModuleException,
NoSuchMethodException,
SecurityException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException

Get the abstract document by a Navigator ID

Parameters:

navigatorId - the navigator id

Returns:

the document

Throws:

WorkflowModuleException - on error

NoSuchMethodException - on error

SecurityException - on error

IllegalAccessException - on error

IllegalArgumentException - on error

InvocationTargetException - on error