com.wewebu.ow.server.plug.owaddmultidocuments
Class OwAddMultipleDocumentsRecordFunction

java.lang.Object
  extended by com.wewebu.ow.server.app.OwFunction
      extended by com.wewebu.ow.server.app.OwRecordFunction
          extended by com.wewebu.ow.server.plug.owaddmultidocuments.OwAddMultipleDocumentsRecordFunction
All Implemented Interfaces:
com.wewebu.ow.server.app.OwPlugin, com.wewebu.ow.server.ui.OwDialog.OwDialogListener, com.wewebu.ow.server.ui.OwUpdateTarget, EventListener

public class OwAddMultipleDocumentsRecordFunction
extends com.wewebu.ow.server.app.OwRecordFunction
implements com.wewebu.ow.server.ui.OwDialog.OwDialogListener

View Module to edit OwObject 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


Field Summary
protected  com.wewebu.ow.server.ecm.OwObject m_folderObject
          last folder object for history events
protected  com.wewebu.ow.server.ecm.OwObject m_rootObject
          last root object for history events
 
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
OwAddMultipleDocumentsRecordFunction()
           
 
Method Summary
protected  int calculateViewMask()
          Calculation of view mask for the create dialog.
protected  OwCreateMultipleDocumentsDialog createCreateMultipleDocumentsDialog(com.wewebu.ow.server.ecm.OwObject folderObject_p, com.wewebu.ow.server.ecm.OwResource resource_p, com.wewebu.ow.server.dmsdialogs.views.classes.OwObjectClassSelectionCfg classSelectionCfg, Collection batchIndexProperties_p, List documentImporters_p, int iViewMask_p)
          (overridable) Factory method for OwCreateMultipleDocumentsDialog instance
protected  OwCreateMultipleDocumentsDialog createCreateMultipleDocumentsDialog(com.wewebu.ow.server.ecm.OwObject folderObject_p, com.wewebu.ow.server.ecm.OwResource resource_p, String strClassName_p, String strParentObjectClass_p, Collection batchIndexProperties_p, List documentImporters_p, int iViewMask_p)
          Deprecated. will be replaced by createCreateMultipleDocumentsDialog(OwObject, OwResource, OwObjectClassSelectionCfg, Collection, List, int)
protected  com.wewebu.ow.server.app.OwJspFormConfigurator createOwJspFromConfigurator(com.wewebu.ow.server.util.OwXMLUtil node_p)
          (overridable) Factory method for OwJspFormConfigurator object
protected  com.wewebu.ow.server.ecm.OwResource findResource(com.wewebu.ow.server.ecm.OwObject parentObject)
          Find the resource which should be used.
 String getBigIcon()
          get the URL to the icon of the dialog / function
protected  com.wewebu.ow.server.dmsdialogs.views.classes.OwObjectClassSelectionCfg getClassSelectionCfg(com.wewebu.ow.server.util.OwXMLUtil config)
          (overridable) Configuration for object class definition.
 String getIcon()
          get the URL to the icon of the dialog / function
protected  com.wewebu.ow.server.app.OwJspFormConfigurator getJspConfigurator()
          Getter for OwJspFormConfigurator.
 boolean getNoEvent()
          prevent clicking on this plugin in this version
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectClassProcessor getProcessor()
          Getter for class processor.
protected  List<com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView.OwPropertyInfo> getPropertyInfos()
          Getter of restricted field definitions, can be null if <EditPropertyList> is not defined.
 void init(com.wewebu.ow.server.util.OwXMLUtil node_p, com.wewebu.ow.server.app.OwMainAppContext context_p)
          override to get some plugin configuration tags.
 boolean isDragDropTarget()
          check if plugin acts as a drag and drop target
 boolean isEnabled(com.wewebu.ow.server.ecm.OwObject rootObject_p, com.wewebu.ow.server.ecm.OwObject folderObject_p, int iContext_p)
          check if function is enabled for the given object parameters
 boolean isMultifileDragDropAllowed()
          check if plugin allows multiple files to be dropped on it
 void onClickEvent(com.wewebu.ow.server.ecm.OwObject rootObject_p, com.wewebu.ow.server.ecm.OwObject folderObject_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)
          Listener for DialogClose events used to historize SUCCESS/CANCEL/FAILURE
 void onUpdate(com.wewebu.ow.server.ui.OwEventTarget caller_p, int code_p, Object param_p)
           
protected  com.wewebu.ow.server.dmsdialogs.views.classes.OwObjectClassSelectionCfg processObjectClassMapping(com.wewebu.ow.server.ecm.OwObject currentParent, com.wewebu.ow.server.dmsdialogs.views.classes.OwObjectClassSelectionCfg classSelectionCfg, int mapDirection, Map<String,String> objectclassmap)
          (overridable) Process object class mapping configuration.
protected  com.wewebu.ow.server.ecm.OwObject processParentObject(com.wewebu.ow.server.ecm.OwObject currentParent)
          Identify object to be used as parent.
 
Methods inherited from class com.wewebu.ow.server.app.OwRecordFunction
addHistoryEvent, addHistoryEvent, getBigDefaultIconHTML, getBigIconHTML, getDefaultIconHTML, getDefaultLabel, getDragDropProperties, getIconHTML, getLabel, getPluginType, onClickEvent
 
Methods inherited from class com.wewebu.ow.server.app.OwFunction
getConfigNode, getContext, getContextMenu, getEventManager, getHelpPath, getName, getPluginID, getPluginTitle, getPluginTypeDisplayName, getSafeSetting, getSupportedObjectClassesFromDescriptor, getSupportedObjectTypesFromDescriptor, getTooltip, isObjectClassSupported, setSafeSetting
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_rootObject

protected com.wewebu.ow.server.ecm.OwObject m_rootObject
last root object for history events


m_folderObject

protected com.wewebu.ow.server.ecm.OwObject m_folderObject
last folder object for history events

Constructor Detail

OwAddMultipleDocumentsRecordFunction

public OwAddMultipleDocumentsRecordFunction()
Method Detail

init

public void init(com.wewebu.ow.server.util.OwXMLUtil node_p,
                 com.wewebu.ow.server.app.OwMainAppContext context_p)
          throws Exception
override to get some plugin configuration tags.

Overrides:
init in class com.wewebu.ow.server.app.OwRecordFunction
Throws:
Exception

getNoEvent

public boolean getNoEvent()
prevent clicking on this plugin in this version

Overrides:
getNoEvent in class com.wewebu.ow.server.app.OwFunction
Returns:
true = do not render link to this plugin

isDragDropTarget

public boolean isDragDropTarget()
check if plugin acts as a drag and drop target

Overrides:
isDragDropTarget in class com.wewebu.ow.server.app.OwRecordFunction
Returns:
true = plugin is drag and drop target and can retrieve uploaded files via OwMainAppContext.getDragAndDropUploadDir, false otherwise

isMultifileDragDropAllowed

public boolean isMultifileDragDropAllowed()
check if plugin allows multiple files to be dropped on it

Overrides:
isMultifileDragDropAllowed in class com.wewebu.ow.server.app.OwRecordFunction
Returns:
true = allow multiple files to be dropped on the plugin, false only single files may be dropped

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

isEnabled

public boolean isEnabled(com.wewebu.ow.server.ecm.OwObject rootObject_p,
                         com.wewebu.ow.server.ecm.OwObject folderObject_p,
                         int iContext_p)
                  throws Exception
check if function is enabled for the given object parameters

Overrides:
isEnabled in class com.wewebu.ow.server.app.OwRecordFunction
Parameters:
rootObject_p - OwObject root folder to work on
folderObject_p - OwObject selected folder to work on
Returns:
true = enabled, false otherwise
Throws:
Exception

onClickEvent

public void onClickEvent(com.wewebu.ow.server.ecm.OwObject rootObject_p,
                         com.wewebu.ow.server.ecm.OwObject folderObject_p,
                         com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                  throws Exception
event called when user clicked the plugin label / icon

Overrides:
onClickEvent in class com.wewebu.ow.server.app.OwRecordFunction
Parameters:
rootObject_p - OwObject root folder to work on
folderObject_p - OwObject selected folder to work on
refreshCtx_p - OwFunctionRefreshContext callback interface for the function plugins to signal refresh events to clients, can be null if no refresh is needed
Throws:
Exception

createCreateMultipleDocumentsDialog

protected OwCreateMultipleDocumentsDialog createCreateMultipleDocumentsDialog(com.wewebu.ow.server.ecm.OwObject folderObject_p,
                                                                              com.wewebu.ow.server.ecm.OwResource resource_p,
                                                                              String strClassName_p,
                                                                              String strParentObjectClass_p,
                                                                              Collection batchIndexProperties_p,
                                                                              List documentImporters_p,
                                                                              int iViewMask_p)
                                                                       throws Exception
Deprecated. will be replaced by createCreateMultipleDocumentsDialog(OwObject, OwResource, OwObjectClassSelectionCfg, Collection, List, int)

overridable factory method

Parameters:
folderObject_p -
resource_p -
strClassName_p -
strParentObjectClass_p -
batchIndexProperties_p -
documentImporters_p - List of OwDocumentImporter objects
iViewMask_p -
Returns:
the newly created OwCreateMultipleDocumentsDialog
Throws:
Exception

createCreateMultipleDocumentsDialog

protected OwCreateMultipleDocumentsDialog createCreateMultipleDocumentsDialog(com.wewebu.ow.server.ecm.OwObject folderObject_p,
                                                                              com.wewebu.ow.server.ecm.OwResource resource_p,
                                                                              com.wewebu.ow.server.dmsdialogs.views.classes.OwObjectClassSelectionCfg classSelectionCfg,
                                                                              Collection batchIndexProperties_p,
                                                                              List documentImporters_p,
                                                                              int iViewMask_p)
                                                                       throws Exception
(overridable) Factory method for OwCreateMultipleDocumentsDialog instance

Parameters:
folderObject_p -
resource_p -
classSelectionCfg -
batchIndexProperties_p -
documentImporters_p -
iViewMask_p -
Returns:
the newly created OwCreateMultipleDocumentsDialog
Throws:
Exception
Since:
4.1.0.0

onDialogClose

public void onDialogClose(com.wewebu.ow.server.ui.OwDialog dialogView_p)
                   throws Exception
Listener for DialogClose events used to historize SUCCESS/CANCEL/FAILURE

Specified by:
onDialogClose in interface com.wewebu.ow.server.ui.OwDialog.OwDialogListener
Parameters:
dialogView_p - the closed dialog
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

createOwJspFromConfigurator

protected com.wewebu.ow.server.app.OwJspFormConfigurator createOwJspFromConfigurator(com.wewebu.ow.server.util.OwXMLUtil node_p)
                                                                              throws Exception
(overridable) Factory method for OwJspFormConfigurator object

Parameters:
node_p - OwXMLUtil node to read configuration
Returns:
OwJspFormConfigurator
Throws:
Exception - if problem with instantiation of JspFormConfigurator
Since:
3.1.0.0

getJspConfigurator

protected com.wewebu.ow.server.app.OwJspFormConfigurator getJspConfigurator()
Getter for OwJspFormConfigurator.

Returns:
OwJspFormConfigurator
Since:
3.1.0.0

getPropertyInfos

protected List<com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView.OwPropertyInfo> getPropertyInfos()
Getter of restricted field definitions, can be null if <EditPropertyList> is not defined.

Returns:
List of OwPropertyInfo or null

getProcessor

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectClassProcessor getProcessor()
Getter for class processor.

Returns:
OwObjectClassProcessor
Since:
4.1.1.0

processParentObject

protected com.wewebu.ow.server.ecm.OwObject processParentObject(com.wewebu.ow.server.ecm.OwObject currentParent)
                                                         throws Exception
Identify object to be used as parent.

By default read configuration <ParentObject> for static parent definition, or return provided current parent instead.

Parameters:
currentParent - OwObject (can be null)
Returns:
OwObject or null
Throws:
Exception
Since:
4.1.1.0

findResource

protected com.wewebu.ow.server.ecm.OwResource findResource(com.wewebu.ow.server.ecm.OwObject parentObject)
                                                    throws Exception
Find the resource which should be used.

Extract resource from provided parent if available, or can return null if provide parent is null.

Parameters:
parentObject - OwObject (can be null)
Returns:
OwResource or null
Throws:
Exception
Since:
4.1.1.0

getClassSelectionCfg

protected com.wewebu.ow.server.dmsdialogs.views.classes.OwObjectClassSelectionCfg getClassSelectionCfg(com.wewebu.ow.server.util.OwXMLUtil config)
                                                                                                throws com.wewebu.ow.server.exceptions.OwConfigurationException
(overridable) Configuration for object class definition.

Parameters:
config - OwXMLUtil current configuration node
Returns:
OwObjectClassSelectionCfg
Throws:
com.wewebu.ow.server.exceptions.OwConfigurationException
Since:
4.1.1.0

processObjectClassMapping

protected com.wewebu.ow.server.dmsdialogs.views.classes.OwObjectClassSelectionCfg processObjectClassMapping(com.wewebu.ow.server.ecm.OwObject currentParent,
                                                                                                            com.wewebu.ow.server.dmsdialogs.views.classes.OwObjectClassSelectionCfg classSelectionCfg,
                                                                                                            int mapDirection,
                                                                                                            Map<String,String> objectclassmap)
                                                                                                     throws Exception
(overridable) Process object class mapping configuration. Return an instance of OwObjectClassSelectionCfg, which should be used for creation dialog.

Parameters:
currentParent - OwObject parent object
classSelectionCfg - OwObjectClassSelectionCfg predefined object class selection
mapDirection - int Constant defining mapping direction see OwMappingUtils
objectclassmap - Map containing defined associations of folder/class
Returns:
OwObjectClassSelection
Throws:
Exception
Since:
4.1.1.0

calculateViewMask

protected int calculateViewMask()
Calculation of view mask for the create dialog.

Returns:
int
Since:
4.1.1.0


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.