com.wewebu.ow.server.plug.owdms

Class OwDocumentFunctionCheckin

java.lang.Object

com.wewebu.ow.server.app.OwFunction

com.wewebu.ow.server.app.OwDocumentFunction

com.wewebu.ow.server.plug.owdms.OwDocumentFunctionCheckin

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 OwDocumentFunctionCheckin
extends com.wewebu.ow.server.app.OwDocumentFunction
implements com.wewebu.ow.server.ui.OwDialog.OwDialogListener

Implementation of the DMS document function checkin.

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

Fields

Modifier and Type	Field and Description
protected OwKeepContentDocumentImporter	keepDocImporter
protected com.wewebu.ow.server.ecm.OwObject	m_checkinObject the last object to check in needed for status historization in onCloseDialog()
protected List	m_documentImporters list of OwDocumentImporter objects that should be displayed as possible document source
protected com.wewebu.ow.server.ecm.OwObject	m_parentObject the last parent object needed for status historization in onCloseDialog()

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
OwDocumentFunctionCheckin()

Method Summary

Methods

Modifier and Type	Method and Description
protected OwCheckInDialog	createCheckInDialog(com.wewebu.ow.server.ecm.OwObject saveObject_p) (overridable) factory method for the creation of check-in dialog
String	getBigIcon() get the URL to the icon of the dialog / function
String	getIcon() get the URL to the icon of the dialog / function
protected org.alfresco.wd.ui.conf.OwPropertyListConfiguration	getPropertyListConfiguration() Getter for current PropertyList configuration
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	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	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)

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, onMultiselectClickEvent

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_checkinObject

protected com.wewebu.ow.server.ecm.OwObject m_checkinObject

the last object to check in needed for status historization in onCloseDialog()

m_parentObject

protected com.wewebu.ow.server.ecm.OwObject m_parentObject

the last parent object needed for status historization in onCloseDialog()

m_documentImporters

protected List m_documentImporters

list of OwDocumentImporter objects that should be displayed as possible document source

keepDocImporter

protected OwKeepContentDocumentImporter keepDocImporter

Constructor Detail

OwDocumentFunctionCheckin

public OwDocumentFunctionCheckin()

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.OwDocumentFunction

Throws:

Exception

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 - OwFunctionRefreshContext callback interface for the function plugins to signal refresh events to clients, can be null if no refresh is needed

Throws:

Exception

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

createCheckInDialog

protected OwCheckInDialog createCheckInDialog(com.wewebu.ow.server.ecm.OwObject saveObject_p)
                                       throws Exception

(overridable) factory method for the creation of check-in dialog

Parameters:

saveObject_p - OwObject to checkin

Returns:

OwCheckInDialog newly created dialog

Throws:

Exception

Since:

2.5.3.0

getPropertyListConfiguration

protected org.alfresco.wd.ui.conf.OwPropertyListConfiguration getPropertyListConfiguration()

Getter for current PropertyList configuration

Returns:

OwPropertyListConfiguration or null if not set

Since:

4.2.0.0