com.wewebu.ow.server.plug.owdocdel
Class OwDocumentFunctionDel

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.owdocdel.OwDocumentFunctionDel
All Implemented Interfaces:
com.wewebu.ow.server.app.OwPlugin

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

Delete Record Function to delete an object.

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
 int TOTAL_ELEMENTS_DISPLAY
          How many object should be displayed in the message box
 
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
OwDocumentFunctionDel()
           
 
Method Summary
protected  void addHistoryEvent(Collection objectnames_p, com.wewebu.ow.server.ecm.OwObject oParent_p, int iEventType_p, int iStatus_p)
          overwrite to use delete event instead add the plugin invoke event to the history manager
 String getBigIcon()
          get the URL to the icon of the dialog / function
 String getIcon()
          get the URL to the icon of the dialog / function
 boolean isEnabled(com.wewebu.ow.server.ecm.OwObject oObject_p, com.wewebu.ow.server.ecm.OwObject oParent_p, int iContext_p)
          check if function is enabled for the given object parameters
 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 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
 
Methods inherited from class com.wewebu.ow.server.app.OwDocumentFunction
addHistoryEvent, getBigDefaultIconHTML, getBigIconHTML, getColumnTitle, getContextMenu, getDefaultIconHTML, getDefaultLabel, getDisplayNameFromUserId, getEnableColumnClickEvent, getIconHTML, getLabel, getMultiselect, getNeedParent, getObjectInstance, getPluginType, getRetrievalPropertyNames, getShowInEditViews, init, 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

TOTAL_ELEMENTS_DISPLAY

public int TOTAL_ELEMENTS_DISPLAY
How many object should be displayed in the message box

Constructor Detail

OwDocumentFunctionDel

public OwDocumentFunctionDel()
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

isEnabled

public boolean isEnabled(com.wewebu.ow.server.ecm.OwObject oObject_p,
                         com.wewebu.ow.server.ecm.OwObject oParent_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.OwDocumentFunction
Parameters:
oObject_p - OwObject where event was triggered
oParent_p - Parent which listed the Object
Returns:
true = enabled, false otherwise
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

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 - Iterator 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

addHistoryEvent

protected void addHistoryEvent(Collection objectnames_p,
                               com.wewebu.ow.server.ecm.OwObject oParent_p,
                               int iEventType_p,
                               int iStatus_p)
                        throws Exception
overwrite to use delete event instead add the plugin invoke event to the history manager

Overrides:
addHistoryEvent in class com.wewebu.ow.server.app.OwDocumentFunction
Parameters:
objectnames_p - Collection of object names. Only String values are permitted.
oParent_p - Parent which listed the Object
iEventType_p - int one out of: OwEventManger.HISTORY_EVENT_TYPE_PLUGIN_INVOKE_UI OwEventManger.HISTORY_EVENT_TYPE_PLUGIN_INVOKE_VIEW OwEventManger.HISTORY_EVENT_TYPE_PLUGIN_INVOKE_EDIT
iStatus_p - int Status as defined in OwEventManger.HISTORY_STATUS_...
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.