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

java.lang.Object
  com.wewebu.ow.server.ui.OwEventTarget
      com.wewebu.ow.server.ui.OwView
          com.wewebu.ow.server.ui.OwLayout
              com.wewebu.ow.server.ui.OwDialog
                  com.wewebu.ow.server.app.OwStandardDialog
                      com.wewebu.ow.server.plug.owbpm.plug.OwBPMInsertNoteDialog

All Implemented Interfaces:

com.wewebu.ow.server.field.OwFieldProvider, com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwUpdateTarget

Direct Known Subclasses:

OwBPMReassignDialog, OwBPMResubmitDialog

public class OwBPMInsertNoteDialog
extends com.wewebu.ow.server.app.OwStandardDialog
implements com.wewebu.ow.server.field.OwFieldProvider

Dialog for asking for a note to be attached to the workitem.

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

Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwDialog

com.wewebu.ow.server.ui.OwDialog.OwDialogListener

Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwLayout

com.wewebu.ow.server.ui.OwLayout.OwDispatchRegion

Field Summary

static int	INSERT_NOTE_DIALOG_REGION_MAX start of overridden regions
protected com.wewebu.ow.server.ecm.bpm.OwWorkitem	m_currentItem inform listeners which is the current item in work
protected com.wewebu.ow.server.app.OwFieldManager	m_fieldManager the field manager
protected com.wewebu.ow.server.app.OwSubMenuView	m_MenuView menu for the buttons
protected com.wewebu.ow.server.ecm.OwProperty	m_noteProperty the note property
protected List	m_workitems the workitems which are to be handled
static int	NOTE_REGION named region for note text area

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

CLOSE_BTN_REGION, FOOTER_REGION, HELP_BTN_REGION, INFO_ICON_REGION, LEFT_REGION, m_strHelpPath, m_strInfoIconURL, m_strTitle, MAIN_REGION, MENU_REGION, RIGHT_REGION, STANDARD_DIALOG_REGION_MAX, TITLE_REGION

Fields inherited from class com.wewebu.ow.server.ui.OwDialog

m_iDEBUG_DocumentViewSize, m_iDEBUG_InitDocument, m_iDEBUG_TargetCount, m_Listener

Fields inherited from class com.wewebu.ow.server.ui.OwLayout

m_Regions

Fields inherited from class com.wewebu.ow.server.ui.OwView

CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget

Fields inherited from interface com.wewebu.ow.server.field.OwFieldProvider

TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL

Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView

EMPTY_STRING

Constructor Summary

OwBPMInsertNoteDialog(List workitems_p, String notePropertyName_p, boolean notePropertyIsNecessary_p)
create a new instance of the dialog

OwBPMInsertNoteDialog(com.wewebu.ow.server.ecm.bpm.OwWorkitem workitem_p, String notePropertyName_p, boolean notePropertyIsNecessary_p)
create a new instance of the dialog

Method Summary

void	detach()
com.wewebu.ow.server.ecm.bpm.OwWorkitem	getCurrentItem() Get the current processing work item
com.wewebu.ow.server.field.OwField	getField(String strFieldClassName_p)
String	getFieldProviderName()
Object	getFieldProviderSource()
int	getFieldProviderType()
Collection	getFields()
Object	getSafeFieldValue(String name_p, Object defaultvalue_p)
Collection	getWorkitems() getter method for workitems
protected void	init()
void	onCancelDo(javax.servlet.http.HttpServletRequest request_p, Object reason_p) event called when user clicked the cancel button should be overloaded by specific Dialog
void	onOkDo(javax.servlet.http.HttpServletRequest request_p, Object reason_p) event called when user clicked the OK button should be overloaded by specific Dialog
protected void	onRender(Writer w_p)
void	renderNote(Writer w_p) Render the note
void	renderRegion(Writer w_p, int iRegion_p) render the views of the region
void	setField(String name_p, Object value_p)
void	setNote(javax.servlet.http.HttpServletRequest request_p) set a note to all workitems of the list
void	unlockAll() unlock the workitems
protected String	usesFormWithAttributes() enable form handling

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

getInfoIcon, getTitle, hasHelpButton, isRegion, onClose, onHelp, renderCloseButton, renderHelpButton, setHelp, setInfoIcon, setTitle

Methods inherited from class com.wewebu.ow.server.ui.OwDialog

closeDialog, setListener

Methods inherited from class com.wewebu.ow.server.ui.OwLayout

addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion

Methods inherited from class com.wewebu.ow.server.ui.OwView

activate, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal

Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget

attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget

Methods inherited from class java.lang.Object

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

Field Detail

NOTE_REGION

public static final int NOTE_REGION

named region for note text area

See Also:

Constant Field Values

INSERT_NOTE_DIALOG_REGION_MAX

public static final int INSERT_NOTE_DIALOG_REGION_MAX

start of overridden regions

See Also:

Constant Field Values

m_workitems

protected List m_workitems

the workitems which are to be handled

m_MenuView

protected com.wewebu.ow.server.app.OwSubMenuView m_MenuView

menu for the buttons

m_currentItem

protected com.wewebu.ow.server.ecm.bpm.OwWorkitem m_currentItem

inform listeners which is the current item in work

m_fieldManager

protected com.wewebu.ow.server.app.OwFieldManager m_fieldManager

the field manager

m_noteProperty

protected com.wewebu.ow.server.ecm.OwProperty m_noteProperty

the note property

Constructor Detail

OwBPMInsertNoteDialog

public OwBPMInsertNoteDialog(List workitems_p,
                             String notePropertyName_p,
                             boolean notePropertyIsNecessary_p)
                      throws com.wewebu.ow.server.exceptions.OwException

create a new instance of the dialog

Parameters:

workitems_p -

notePropertyName_p - if null note property is ignored

notePropertyIsNecessary_p - is the property note necessary. if true missing note property throws an exception

Throws:

com.wewebu.ow.server.exceptions.OwException

OwBPMInsertNoteDialog

public OwBPMInsertNoteDialog(com.wewebu.ow.server.ecm.bpm.OwWorkitem workitem_p,
                             String notePropertyName_p,
                             boolean notePropertyIsNecessary_p)
                      throws com.wewebu.ow.server.exceptions.OwException

create a new instance of the dialog

Parameters:

workitem_p -

notePropertyName_p -

notePropertyIsNecessary_p - is the property note necessary. if true missing note property throws an exception

Throws:

com.wewebu.ow.server.exceptions.OwException

Method Detail

usesFormWithAttributes

protected String usesFormWithAttributes()

enable form handling

Overrides:

usesFormWithAttributes in class com.wewebu.ow.server.ui.OwView

init

protected void init()
             throws Exception

Overrides:

init in class com.wewebu.ow.server.ui.OwView

Throws:

Exception

See Also:

OwView.init()

onCancelDo

public void onCancelDo(javax.servlet.http.HttpServletRequest request_p,
                       Object reason_p)
                throws Exception

event called when user clicked the cancel button should be overloaded by specific Dialog

Parameters:

request_p - a HttpServletRequest

reason_p -

Throws:

Exception

onOkDo

public void onOkDo(javax.servlet.http.HttpServletRequest request_p,
                   Object reason_p)
            throws Exception

event called when user clicked the OK button should be overloaded by specific Dialog

Parameters:

request_p - a HttpServletRequest

reason_p -

Throws:

Exception

renderRegion

public void renderRegion(Writer w_p,
                         int iRegion_p)
                  throws Exception

render the views of the region

Specified by:

renderRegion in interface com.wewebu.ow.server.ui.OwBaseView

Overrides:

renderRegion in class com.wewebu.ow.server.app.OwStandardDialog

Parameters:

w_p - Writer object to write HTML to

iRegion_p - ID of the region to render

Throws:

Exception

renderNote

public void renderNote(Writer w_p)
                throws Exception

Render the note

Parameters:

w_p -

Throws:

Exception

Since:

2.5.2.0

setNote

public void setNote(javax.servlet.http.HttpServletRequest request_p)
             throws Exception

set a note to all workitems of the list

Parameters:

request_p -

Throws:

Exception

unlockAll

public void unlockAll()
               throws Exception

unlock the workitems

Throws:

Exception

getWorkitems

public Collection getWorkitems()

getter method for workitems

Returns:

Returns the workitems.

getCurrentItem

public com.wewebu.ow.server.ecm.bpm.OwWorkitem getCurrentItem()

Get the current processing work item

Returns:

the current work item

Since:

2.5.2.0

onRender

protected void onRender(Writer w_p)
                 throws Exception

Overrides:

onRender in class com.wewebu.ow.server.app.OwStandardDialog

Throws:

Exception

Since:

2.5.2.0

See Also:

OwStandardDialog.onRender(java.io.Writer)

detach

public void detach()

Overrides:

detach in class com.wewebu.ow.server.ui.OwView

Since:

2.5.2.0

See Also:

OwView.detach()

getField

public com.wewebu.ow.server.field.OwField getField(String strFieldClassName_p)
                                            throws Exception,
                                                   com.wewebu.ow.server.exceptions.OwObjectNotFoundException

Specified by:

getField in interface com.wewebu.ow.server.field.OwFieldProvider

Throws:

Exception

com.wewebu.ow.server.exceptions.OwObjectNotFoundException

Since:

2.5.2.0

See Also:

OwFieldProvider.getField(java.lang.String)

getFieldProviderName

public String getFieldProviderName()

Specified by:

getFieldProviderName in interface com.wewebu.ow.server.field.OwFieldProvider

Since:

2.5.2.0

See Also:

OwFieldProvider.getFieldProviderName()

getFieldProviderSource

public Object getFieldProviderSource()

Specified by:

getFieldProviderSource in interface com.wewebu.ow.server.field.OwFieldProvider

Since:

2.5.2.0

See Also:

OwFieldProvider.getFieldProviderSource()

getFieldProviderType

public int getFieldProviderType()

Specified by:

getFieldProviderType in interface com.wewebu.ow.server.field.OwFieldProvider

Since:

2.5.2.0

See Also:

OwFieldProvider.getFieldProviderType()

getFields

public Collection getFields()
                     throws Exception

Specified by:

getFields in interface com.wewebu.ow.server.field.OwFieldProvider

Throws:

Exception

Since:

2.5.2.0

See Also:

OwFieldProvider.getFields()

getSafeFieldValue

public Object getSafeFieldValue(String name_p,
                                Object defaultvalue_p)

Specified by:

getSafeFieldValue in interface com.wewebu.ow.server.field.OwFieldProvider

Since:

2.5.2.0

See Also:

OwFieldProvider.getSafeFieldValue(java.lang.String, java.lang.Object)

setField

public void setField(String name_p,
                     Object value_p)
              throws Exception,
                     com.wewebu.ow.server.exceptions.OwObjectNotFoundException

Specified by:

setField in interface com.wewebu.ow.server.field.OwFieldProvider

Throws:

Exception

com.wewebu.ow.server.exceptions.OwObjectNotFoundException

Since:

2.5.2.0

See Also:

OwFieldProvider.setField(java.lang.String, java.lang.Object)