com.wewebu.ow.server.plug.owbpm.plug

Class OwBPMStepProcessorFunction

java.lang.Object

com.wewebu.ow.server.app.OwFunction

com.wewebu.ow.server.app.OwDocumentFunction

com.wewebu.ow.server.plug.owbpm.plug.OwBPMStepProcessorFunction

All Implemented Interfaces:

com.wewebu.ow.server.app.OwPlugin, com.wewebu.ow.server.ui.OwDialog.OwDialogListener, com.wewebu.ow.server.ui.OwUpdateTarget, EventListener

Direct Known Subclasses:

OwAlfrescoBPMStepProcessorFunction

public class OwBPMStepProcessorFunction
extends com.wewebu.ow.server.app.OwDocumentFunction
implements com.wewebu.ow.server.ui.OwDialog.OwDialogListener

Workdesk BPM Plugin.
Workdesk BPM Plugin for a Standard/JSP Processor which displays all properties.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Since:

3.1.0.0

Field Summary

Fields inherited from class com.wewebu.ow.server.app.OwFunction

DESCRIPTION_KEY_CLASSES, DESCRIPTION_KEY_OBJ_TYPES, DESCRIPTION_KEY_TYPE, DRAG_DROP_PROPERTY_MAX_FILESIZE, m_MainContext

Constructor Summary

Constructors

Constructor and Description
OwBPMStepProcessorFunction()

Method Summary

Methods

Modifier and Type	Method and Description
protected com.wewebu.ow.server.app.OwStandardSequenceDialog	createDialog(Collection objects_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p, com.wewebu.ow.server.util.OwXMLUtil configNode_p) Create the corresponding dialog.
protected OwBPMJspProcessorDialog	createJspProcessorDialog(Collection objects_p, com.wewebu.ow.server.util.OwXMLUtil configNode_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p) Create the JSP based step processor dialog.
protected OwBPMStandardProcessorDialog	createProcessorDialog(Collection objects_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p, com.wewebu.ow.server.util.OwXMLUtil configNode_p) overridable factory method
String	getBigIcon() get the URL to the icon of the dialog / function
String	getIcon() get the URL to the icon of the dialog / function
void	onClickEvent(com.wewebu.ow.server.ecm.OwObject oObject_p, com.wewebu.ow.server.ecm.OwObject oParent_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p) event called when user clicked the plugin label / icon
void	onDialogClose(com.wewebu.ow.server.ui.OwDialog dialogView_p) called if the Dialog that was opened by this view closes
void	onMultiselectClickEvent(Collection objects_p, com.wewebu.ow.server.ecm.OwObject oParent_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p) event called when user clicked the plugin for multiple selected items
void	onUpdate(com.wewebu.ow.server.ui.OwEventTarget caller_p, int code_p, Object param_p)

Methods inherited from class com.wewebu.ow.server.app.OwDocumentFunction

addHistoryEvent, addHistoryEvent, getBigDefaultIconHTML, getBigIconHTML, getColumnTitle, getContextMenu, getDefaultIconHTML, getDefaultLabel, getDisplayNameFromUserId, getEnableColumnClickEvent, getIconHTML, getLabel, getMultiselect, getNeedParent, getObjectInstance, getPluginType, getRetrievalPropertyNames, getShowInEditViews, init, isEnabled, isEnabled, isObjectTypeSupported, onColumnClickEvent

Methods inherited from class com.wewebu.ow.server.app.OwFunction

getConfigNode, getContext, getDragDropProperties, getEventManager, getHelpPath, getName, getNoEvent, getPluginID, getPluginTitle, getPluginTypeDisplayName, getSafeSetting, getSupportedObjectClassesFromDescriptor, getSupportedObjectTypesFromDescriptor, getTooltip, isDragDropTarget, isObjectClassSupported, setSafeSetting

Methods inherited from class java.lang.Object

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

Constructor Detail

OwBPMStepProcessorFunction

public OwBPMStepProcessorFunction()

Method Detail

getIcon

public String getIcon()
               throws Exception

get the URL to the icon of the dialog / function

Specified by:

getIcon in interface com.wewebu.ow.server.app.OwPlugin

Overrides:

getIcon in class com.wewebu.ow.server.app.OwFunction

Throws:

Exception

getBigIcon

public String getBigIcon()
                  throws Exception

get the URL to the icon of the dialog / function

Overrides:

getBigIcon in class com.wewebu.ow.server.app.OwFunction

Throws:

Exception

onClickEvent

public void onClickEvent(com.wewebu.ow.server.ecm.OwObject oObject_p,
                com.wewebu.ow.server.ecm.OwObject oParent_p,
                com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                  throws Exception

event called when user clicked the plugin label / icon

Specified by:

onClickEvent in class com.wewebu.ow.server.app.OwDocumentFunction

Parameters:

oObject_p - OwObject where event was triggered

oParent_p - Parent which listed the Object

refreshCtx_p - OwClientRefreshContext callback interface for the function plugins to signal refresh events to clients, can be null if no refresh is needed

Throws:

Exception

createProcessorDialog

protected OwBPMStandardProcessorDialog createProcessorDialog(Collection objects_p,
                                                 com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p,
                                                 com.wewebu.ow.server.util.OwXMLUtil configNode_p)
                                                      throws Exception

overridable factory method

Parameters:

objects_p -

refreshCtx_p -

configNode_p -

Returns:

OwBPMPreviewProcessorDialog

Throws:

Exception

onMultiselectClickEvent

public void onMultiselectClickEvent(Collection objects_p,
                           com.wewebu.ow.server.ecm.OwObject oParent_p,
                           com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                             throws Exception

event called when user clicked the plugin for multiple selected items

Overrides:

onMultiselectClickEvent in class com.wewebu.ow.server.app.OwDocumentFunction

Parameters:

objects_p - Collection of OwObject

oParent_p - Parent which listed the Objects

refreshCtx_p - OwClientRefreshContext callback interface for the function plugins to signal refresh events to clients, can be null if no refresh is needed

Throws:

Exception

createDialog

protected com.wewebu.ow.server.app.OwStandardSequenceDialog createDialog(Collection objects_p,
                                                             com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p,
                                                             com.wewebu.ow.server.util.OwXMLUtil configNode_p)
                                                                  throws Exception

Create the corresponding dialog.

Parameters:

objects_p -

refreshCtx_p -

configNode_p -

Returns:

the dialog object

Throws:

Exception

Since:

3.1.0.0

onDialogClose

public void onDialogClose(com.wewebu.ow.server.ui.OwDialog dialogView_p)
                   throws Exception

called if the Dialog that was opened by this view closes

Specified by:

onDialogClose in interface com.wewebu.ow.server.ui.OwDialog.OwDialogListener

Parameters:

dialogView_p - the Dialog that closed.

Throws:

Exception

onUpdate

public void onUpdate(com.wewebu.ow.server.ui.OwEventTarget caller_p,
            int code_p,
            Object param_p)
              throws Exception

Specified by:

onUpdate in interface com.wewebu.ow.server.ui.OwUpdateTarget

Throws:

Exception

See Also:

OwUpdateTarget.onUpdate(com.wewebu.ow.server.ui.OwEventTarget, int, java.lang.Object)

createJspProcessorDialog

protected OwBPMJspProcessorDialog createJspProcessorDialog(Collection objects_p,
                                               com.wewebu.ow.server.util.OwXMLUtil configNode_p,
                                               com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                                                    throws Exception

Create the JSP based step processor dialog.

Parameters:

objects_p - - the collection of objects.

configNode_p - - the configuration node.

refreshCtx_p - - the refresh context object.

Returns:

the newly created OwBPMJspProcessorDialog

Throws:

Exception