com.wewebu.ow.server.plug.owdms

Class OwCheckInDialog

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.owdms.OwSaveDlgDialog

com.wewebu.ow.server.plug.owdms.OwCheckInDialog

All Implemented Interfaces:

com.wewebu.ow.server.app.OwClientRefreshContext, com.wewebu.ow.server.dmsdialogs.views.OwObjectClassView.OwObjectClassViewListner, OwSaveDlgDocumentImportView.OwSaveDlgDocumentImportViewListner, OwSaveDlgObjectPropertyView.OwSaveDlgObjectPropertyViewListner, com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwDialog.OwDialogListener, com.wewebu.ow.server.ui.OwUpdateTarget, EventListener

public class OwCheckInDialog
extends OwSaveDlgDialog
implements com.wewebu.ow.server.app.OwClientRefreshContext

Implementation of OwSaveDlgDialog to create a check in dialog for a given 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

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, com.wewebu.ow.server.ui.OwLayout.OwLayoutViewRefrence

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DIALOG_STATUS_FAILED status of this dialog: checkin failed
protected static int	DIALOG_STATUS_NONE status of this dialog: nothing done yet
protected static int	DIALOG_STATUS_OK status of this dialog: checkin successful
protected int	m_dialogStatus status of this dialog needed for historization
static int	VIEW_MASK_CHECKIN_MODE_OPTION view flag
static int	VIEW_MASK_RELEASE_VERSION_DEFAULT view flag
static int	VIEW_MASK_RELEASE_VERSION_OPTION view flag

Fields inherited from class com.wewebu.ow.server.plug.owdms.OwSaveDlgDialog

m_classView, m_docImportView, m_document, m_fSaveOnly, m_indexClassView, m_indexPropertyView, m_iViewMask, m_Layout, m_PropertyView, m_RefreshCtx, m_strParentObjectClass, m_SubNavigation, m_ValuesMap, VIEW_PROPERTY_CLASS_VIEW, VIEW_PROPERTY_ENABLE_MULTIPLE_FILE_UPLOAD, VIEW_PROPERTY_ENABLE_PASTE_METADATA

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.ui.OwBaseView

EMPTY_STRING

Constructor Summary

Constructors

Constructor and Description
OwCheckInDialog(com.wewebu.ow.server.ecm.OwObject saveObject_p, List documentImporters_p) construct a CheckIn dialog to save the given object

Method Summary

Methods

Modifier and Type	Method and Description
void	detach() Remove view and all subviews from context
int	getDocumentImporterContext() (overridable) Context for the DocumentImporter which are initialized by the OwSaveDlgDocumentImportView
org.alfresco.wd.ui.conf.OwPropertyListConfiguration	getPropertyListConfiguration() Getter for current PropertyList configuration
int	getStatus() get the current status of this dialog
String	getTitle() overridable to display the title of the dialog
protected void	init() init the target after the context is set.
void	onClientRefreshContextUpdate(int reason_p, Object param_p)
void	onDocumentImported() Event fired when document has been imported
protected void	onPostProcessDialogClose(com.wewebu.ow.server.ui.OwDialog dialog_p) Will be called if a postprocess dialog was opened, after closing it again.
void	onSaveDocument(com.wewebu.ow.server.ecm.OwContentCollection content_p, String strMimeType_p, String strMimeParameter_p, Object checkinMode_p, boolean fReleaseVersion_p) called when user clicks save on the source view, finishes the dialog, save the prepared content
protected void	performSave() Implementation of the abstract method defined in OwSaveDlgDialog that performs the actual checkin operation.
void	setPropertiesInfo(List propertiesInfo_p) Deprecated. since 4.2.0.0 use setPropertyListConfiguration(OwPropertyListConfiguration) instead
void	setPropertyListConfiguration(org.alfresco.wd.ui.conf.OwPropertyListConfiguration propLstConf) Set PropertyList configuration

Methods inherited from class com.wewebu.ow.server.plug.owdms.OwSaveDlgDialog

cleanup, createDocumentImportView, getCurrentDocument, getDocumentImporters, getPostProcessingDialog, hasViewMask, isPostProcessDialogOpen, isRegion, onClose, onDialogClose, onObjectClassViewSelectClass, onSaveDocument, onUpdate, openPostProcessingView, renderRegion, setIsPostProcessDialogOpen, setRefreshContext, setValues, setViewMask

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

getInfoIcon, hasHelpButton, onHelp, onRender, 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, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes

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

DIALOG_STATUS_NONE

protected static final int DIALOG_STATUS_NONE

status of this dialog: nothing done yet

See Also:

Constant Field Values

DIALOG_STATUS_OK

protected static final int DIALOG_STATUS_OK

status of this dialog: checkin successful

See Also:

Constant Field Values

DIALOG_STATUS_FAILED

protected static final int DIALOG_STATUS_FAILED

status of this dialog: checkin failed

See Also:

Constant Field Values

VIEW_MASK_CHECKIN_MODE_OPTION

public static final int VIEW_MASK_CHECKIN_MODE_OPTION

view flag

See Also:

Constant Field Values

VIEW_MASK_RELEASE_VERSION_OPTION

public static final int VIEW_MASK_RELEASE_VERSION_OPTION

view flag

See Also:

Constant Field Values

VIEW_MASK_RELEASE_VERSION_DEFAULT

public static final int VIEW_MASK_RELEASE_VERSION_DEFAULT

view flag

See Also:

Constant Field Values

m_dialogStatus

protected int m_dialogStatus

status of this dialog needed for historization

Constructor Detail

OwCheckInDialog

public OwCheckInDialog(com.wewebu.ow.server.ecm.OwObject saveObject_p,
               List documentImporters_p)
                throws Exception

construct a CheckIn dialog to save the given object

Parameters:

saveObject_p - OwObject to checkin

documentImporters_p - List of document importers to use

Throws:

Exception

Method Detail

setPropertiesInfo

public void setPropertiesInfo(List propertiesInfo_p)

Deprecated. since 4.2.0.0 use setPropertyListConfiguration(OwPropertyListConfiguration) instead

List of available properties

Parameters:

propertiesInfo_p - properties info

Since:

3.1.0.3

getStatus

public int getStatus()

get the current status of this dialog

Returns:

the status

init

protected void init()
             throws Exception

init the target after the context is set.

Overrides:

init in class OwSaveDlgDialog

Throws:

Exception

getTitle

public String getTitle()

overridable to display the title of the dialog

Specified by:

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

Overrides:

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

Returns:

title

onSaveDocument

public void onSaveDocument(com.wewebu.ow.server.ecm.OwContentCollection content_p,
                  String strMimeType_p,
                  String strMimeParameter_p,
                  Object checkinMode_p,
                  boolean fReleaseVersion_p)
                    throws Exception

called when user clicks save on the source view, finishes the dialog, save the prepared content

Parameters:

content_p - OwContentCollection

strMimeType_p - String

strMimeParameter_p - String

checkinMode_p - optional Object, used with checkin operation only, can be null

fReleaseVersion_p - optional boolean flag to create a release version, used with checkin operation only

Throws:

Exception

performSave

protected void performSave()
                    throws Exception

Implementation of the abstract method defined in OwSaveDlgDialog that performs the actual checkin operation.

Specified by:

performSave in class OwSaveDlgDialog

Throws:

Exception

onClientRefreshContextUpdate

public void onClientRefreshContextUpdate(int reason_p,
                                Object param_p)
                                  throws Exception

Specified by:

onClientRefreshContextUpdate in interface com.wewebu.ow.server.app.OwClientRefreshContext

Throws:

Exception

getDocumentImporterContext

public int getDocumentImporterContext()

Description copied from class: OwSaveDlgDialog

(overridable) Context for the DocumentImporter which are initialized by the OwSaveDlgDocumentImportView

Overrides:

getDocumentImporterContext in class OwSaveDlgDialog

Returns:

int OwDocumentImporter.IMPORT_CONTEXT_...

onDocumentImported

public void onDocumentImported()
                        throws Exception

Description copied from interface: OwSaveDlgDocumentImportView.OwSaveDlgDocumentImportViewListner

Event fired when document has been imported

Specified by:

onDocumentImported in interface OwSaveDlgDocumentImportView.OwSaveDlgDocumentImportViewListner

Overrides:

onDocumentImported in class OwSaveDlgDialog

Throws:

Exception

onPostProcessDialogClose

protected void onPostProcessDialogClose(com.wewebu.ow.server.ui.OwDialog dialog_p)
                                 throws Exception

Description copied from class: OwSaveDlgDialog

Will be called if a postprocess dialog was opened, after closing it again.

Specified by:

onPostProcessDialogClose in class OwSaveDlgDialog

Parameters:

dialog_p - OwDialog which was used for post processing

Throws:

Exception

detach

public void detach()

Description copied from class: OwSaveDlgDialog

Remove view and all subviews from context

Overrides:

detach in class OwSaveDlgDialog

setPropertyListConfiguration

public void setPropertyListConfiguration(org.alfresco.wd.ui.conf.OwPropertyListConfiguration propLstConf)

Set PropertyList configuration

Parameters:

propLstConf - OwPropertyListConfiguration (can be null)

Since:

4.2.0.0

getPropertyListConfiguration

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

Getter for current PropertyList configuration

Returns:

OwPropertyListConfiguration or null if not set

Since:

4.2.0.0