com.wewebu.ow.server.plug.owbpm.plug
Class OwBPMLaunchProcessorFunction

java.lang.Object
  extended by com.wewebu.ow.server.app.OwFunction
      extended by com.wewebu.ow.server.app.OwDocumentFunction
          extended by com.wewebu.ow.server.plug.owbpm.plug.OwBPMLaunchProcessorFunction
All Implemented Interfaces:
com.wewebu.ow.server.app.OwPlugin

public class OwBPMLaunchProcessorFunction
extends com.wewebu.ow.server.app.OwDocumentFunction

Class for workflow launch document functions.
Depending on configuration, the workflow properties are rendered using a JSP file, or in a standard manner.

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


Nested Class Summary
protected static interface OwBPMLaunchProcessorFunction.OwBPMWorkflowLauncherFactory
          Factory interface used to create a OwBPMWorkflowLauncher object.
protected  class OwBPMLaunchProcessorFunction.OwJSPWorkflowLauncherFactory
          Concrete factory use to create a JSP based workflow launcher.
protected  class OwBPMLaunchProcessorFunction.OwStandardWorkflowLauncherFactory
          Concrete factory use to create a standard workflow launcher.
 
Field Summary
protected  com.wewebu.ow.server.ecm.bpm.OwWorkitemRepository m_bpmRepository
          the work item repository
protected  OwBPMLaunchProcessorFunction.OwBPMWorkflowLauncherFactory m_workflowLauncherFactory
          the workflow launcher factory object
 
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
OwBPMLaunchProcessorFunction()
          Constructor.
 
Method Summary
protected  OwBPMWorkflowLauncher createLauncher(Collection targetObjects_p)
          (overridable) Creates a custom workflow launcher for this document function
protected  OwBPMLaunchProcessorFunction.OwBPMWorkflowLauncherFactory createWorkflowLauncherFactory(com.wewebu.ow.server.util.OwXMLUtil node_p)
          Creates the concrete factory for workflow launcher.
 String getBigIcon()
          get the big (24x24 pixels) icon URL for this plugin to be displayed
 String getIcon()
          get the small (16x16 pixels) icon URL for this plugin to be displayed
protected  com.wewebu.ow.server.ecm.bpm.OwWorkitemRepository getWorkitemRepository()
          Get the OwWorkitemRepository object
 void init(com.wewebu.ow.server.util.OwXMLUtil node_p, com.wewebu.ow.server.app.OwMainAppContext context_p)
           
 boolean isEnabled(com.wewebu.ow.server.ecm.OwObject object_p, com.wewebu.ow.server.ecm.OwObject parent_p, int context_p)
           
 void onClickEvent(com.wewebu.ow.server.ecm.OwObject object_p, com.wewebu.ow.server.ecm.OwObject parent_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
           
 void onMultiselectClickEvent(Collection objects_p, com.wewebu.ow.server.ecm.OwObject parent_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_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, 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
 

Field Detail

m_bpmRepository

protected com.wewebu.ow.server.ecm.bpm.OwWorkitemRepository m_bpmRepository
the work item repository


m_workflowLauncherFactory

protected OwBPMLaunchProcessorFunction.OwBPMWorkflowLauncherFactory m_workflowLauncherFactory
the workflow launcher factory object

Constructor Detail

OwBPMLaunchProcessorFunction

public OwBPMLaunchProcessorFunction()
Constructor.

Method Detail

init

public void init(com.wewebu.ow.server.util.OwXMLUtil node_p,
                 com.wewebu.ow.server.app.OwMainAppContext context_p)
          throws Exception
Overrides:
init in class com.wewebu.ow.server.app.OwDocumentFunction
Throws:
Exception

createWorkflowLauncherFactory

protected OwBPMLaunchProcessorFunction.OwBPMWorkflowLauncherFactory createWorkflowLauncherFactory(com.wewebu.ow.server.util.OwXMLUtil node_p)
Creates the concrete factory for workflow launcher.

Parameters:
node_p - - the configuration node
Returns:
- the concrete factory used to create a workflow launcher object.
Since:
3.1.0.0

isEnabled

public boolean isEnabled(com.wewebu.ow.server.ecm.OwObject object_p,
                         com.wewebu.ow.server.ecm.OwObject parent_p,
                         int context_p)
                  throws Exception
Overrides:
isEnabled in class com.wewebu.ow.server.app.OwDocumentFunction
Throws:
Exception

onClickEvent

public final void onClickEvent(com.wewebu.ow.server.ecm.OwObject object_p,
                               com.wewebu.ow.server.ecm.OwObject parent_p,
                               com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                        throws Exception
Specified by:
onClickEvent in class com.wewebu.ow.server.app.OwDocumentFunction
Throws:
Exception

onMultiselectClickEvent

public void onMultiselectClickEvent(Collection objects_p,
                                    com.wewebu.ow.server.ecm.OwObject parent_p,
                                    com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                             throws Exception
Overrides:
onMultiselectClickEvent in class com.wewebu.ow.server.app.OwDocumentFunction
Throws:
Exception

getWorkitemRepository

protected com.wewebu.ow.server.ecm.bpm.OwWorkitemRepository getWorkitemRepository()
Get the OwWorkitemRepository object

Returns:
- the associated OwWorkitemRepository object.

createLauncher

protected OwBPMWorkflowLauncher createLauncher(Collection targetObjects_p)
                                        throws Exception
(overridable) Creates a custom workflow launcher for this document function

Parameters:
targetObjects_p -
Returns:
the custom OwBPMWorkflowLauncher
Throws:
Exception

getIcon

public String getIcon()
               throws Exception
get the small (16x16 pixels) icon URL for this plugin to be displayed

Specified by:
getIcon in interface com.wewebu.ow.server.app.OwPlugin
Overrides:
getIcon in class com.wewebu.ow.server.app.OwFunction
Returns:
String icon URL
Throws:
Exception
Since:
3.1.0.0

getBigIcon

public String getBigIcon()
                  throws Exception
get the big (24x24 pixels) icon URL for this plugin to be displayed

Overrides:
getBigIcon in class com.wewebu.ow.server.app.OwFunction
Returns:
String icon URL
Throws:
Exception
Since:
3.1.0.0


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.