public class OwRecordDocument
extends com.wewebu.ow.server.app.OwMasterDocument
implements com.wewebu.ow.server.ui.OwTreeView.OwTreeViewEventListner, com.wewebu.ow.server.app.OwClientRefreshContext, com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
RecordDocument Implementation. The Document to the record management tab.
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
Modifier and Type | Field and Description |
---|---|
protected static String |
CONFIG_NODE_CLIENT_FILTER |
static String |
CONFIG_NODE_DOCUMENTFUNCTIONPLUGINS
configuration node name <DocumentFunctionPlugins>
|
static String |
CONFIG_NODE_ENABLEDDOCUMENTFUNCTIONS
configuration node name <EnabledDocumentFunctions>
|
protected static String |
CONFIG_NODE_PAGEABLE |
static String |
CONFIG_NODE_RECORDFUNCTIONPLUGINS
configuration node name <RecordFunctionPlugins>
|
protected static String |
CONFIG_NODE_SHOWFOLDERS
configuration node name "DisplayFoldersInResultList"
|
static String |
CONFIG_NODE_USE_DYNAMIC_SPLIT
The configuration element for dynamic split flag
|
protected int |
m_iMaxSize
max number of result items in a search
|
protected com.wewebu.ow.server.ui.OwTreeView |
m_ResultTreeView
reference to the tree view
|
protected com.wewebu.ow.server.ecm.OwObject |
m_RootFolderObject
the current root folder object
|
protected List |
m_rulesList
Map of List of OwPriorityRule rules to be applied on records
To be accessed via
getRulesList() . |
protected String |
m_strSubFolderPath
current open subfolder
|
protected com.wewebu.ow.server.ecm.OwObject |
m_SubFolderObject
the current open sub folder object
|
protected com.wewebu.ow.server.ecm.OwObject |
m_subFolderObjectParent
the parent of the current open sub folder object
|
static String |
PLUGIN_DOC_CONFIG_PARAMETER |
static String |
PLUGIN_LIST_ENABLED_ATTRIBUTE
enabled attribute for function plugin lists
|
static String |
SETTINGS_PARAM_COLUMN_INFO
settings parameter name for the column info list for the node list view.
|
static String |
SETTINGS_PARAM_SORT
settings parameter name for the sorting.
|
Constructor and Description |
---|
OwRecordDocument() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
checkValidSearchCriteria()
(overridable) we must not send empty searches to the ECM system in order to prevent mass requests
|
protected Collection<com.wewebu.ow.server.field.OwFieldDefinition> |
collectFilterProperties(Collection columnInfoList_p)
Create a filter properties collection which will be provided to the current OwObjectCollection.
|
protected OwRecordFilterOperatorHelper |
createFilterOperatorHelper()
(overridable)
Factory method to create an instance of a FilterOperatorHelper.
|
protected com.wewebu.ow.server.app.OwDynamicLayoutSettings |
createLayoutSettings()
Create layout settings.
|
void |
enableSearchTemplateView(boolean enablesearchtemplateview_p)
called from the search template view to signal that a valid search is available
|
com.wewebu.ow.server.ecm.OwObject |
getCurrentRootFolder()
get the currently opened folder
|
String |
getCurrentSubFolderDisplayPath()
get the currently opened sub folder display path
|
com.wewebu.ow.server.ecm.OwObject |
getCurrentSubFolderObject()
get the currently opened sub folder object
|
com.wewebu.ow.server.ecm.OwObject |
getCurrentSubFolderObjectParent() |
String |
getCurrentSubFolderPath()
get the currently opened sub folder path
|
protected Collection |
getDefaultColumnInfo()
get the default column info for the child list if no column info is defined in the opened folder
|
protected com.wewebu.ow.server.util.OwXMLUtil |
getDocumentFunctionPluginsNode()
get the document function plugin definition node
|
protected com.wewebu.ow.server.util.OwXMLUtil |
getDocumentFunctionsNode()
get the document functions definition node or null if config element is missing
|
protected com.wewebu.ow.server.field.OwSort |
getFolderSortCriteria()
Returns the folder sort criteria as defined in plugin description node.
Folder sort criteria can be defined via <FolderSortCriteria>
tag in owplugins.xml . |
protected boolean |
getIsPluginsEnabled()
check if any function plugins are configured
|
com.wewebu.ow.server.app.OwDynamicLayoutSettings |
getLayoutSettings()
Get the
OwDynamicLayoutSettings instance. |
protected com.wewebu.ow.server.collections.OwLoadContext |
getLoadContext() |
int |
getMaxChildSize()
get the maximum size for object children
|
protected com.wewebu.ow.server.util.OwXMLUtil |
getRecordFunctionPluginsNode()
get the record function plugin definition node
|
protected List |
getRulesList()
One time priority rules read utility
|
com.wewebu.ow.server.field.OwSearchTemplate |
getSearchTemplate()
get the optional searchtemplate to use or null if not defined
|
String |
getTreeViewId()
Get the id of the configured
OwTreeView object. |
protected void |
init()
init the target after the context is set.
|
boolean |
isClientFilterEnabled()
Checks if the client side (OWD) filtering is enabled.
|
boolean |
isDynamicSplitInUse()
Check if dynamic split is used.
|
boolean |
isMaxSizeEnabled() |
boolean |
isPropertyPreviewViewEnabled()
signal that a the property preview should be displayed
|
boolean |
isSearchTemplateViewEnabled()
signal that a valid search is available and the view should be displayed
|
void |
onClientRefreshContextUpdate(int iReason_p,
Object param_p)
implementation of the OwFunction.OwFunctionRefreshContext interface
Called from a plugin to inform its client and cause refresh of display data
|
Object |
onDispatch(int iCode_p,
Object param1_p,
Object param2_p)
This function will be overloaded by the targets (Views and Documents) to perform a generic action on this target.
|
void |
onObjectListViewFilterChange(com.wewebu.ow.server.field.OwSearchNode filterNode_p,
com.wewebu.ow.server.ecm.OwObject parent_p) |
String |
onObjectListViewGetRowClassName(int iIndex_p,
com.wewebu.ow.server.ecm.OwObject obj_p)
get the style class name for the row
|
boolean |
onObjectListViewItemClick(com.wewebu.ow.server.ecm.OwObject obj_p) |
void |
onObjectListViewSelect(com.wewebu.ow.server.ecm.OwObject object_p,
com.wewebu.ow.server.ecm.OwObject parent_p) |
void |
onObjectListViewSort(com.wewebu.ow.server.field.OwSort newSort_p,
String strSortProperty_p) |
void |
onTreeViewNavigateFolder(com.wewebu.ow.server.ui.OwTreeView.OwTreeViewNode node_p)
implementation of OwTreeView.OwTreeViewEventListner: event called when a user opens a folder to display its document contents
overridden from OwObjectTreeView.OwObjectTreeViewEventListner
|
void |
onTreeViewOpenFolder(com.wewebu.ow.server.ui.OwTreeView.OwTreeViewNode node_p)
implementation of OwTreeView.OwTreeViewEventListner: event called when a user navigates through the tree (using plus minus icon), but does not open a folder
overridden from OwObjectTreeView.OwObjectTreeViewEventListner
|
void |
openFolder(com.wewebu.ow.server.ecm.OwObject folder_p,
String strSubFolderPath_p)
open the specified folder in the plugin
|
void |
setMaxChildSize(int iMax_p)
set the maximum size for object children
|
void |
setResultTreeView(com.wewebu.ow.server.ui.OwTreeView resultTreeView_p)
set the result tree view to be used by the record plugin
|
protected boolean |
showFolderInResultList()
Flag which is used to verify, if folders should be shown in
result list or not.
|
boolean |
supportLock()
is lock supported in plugin definition
|
void |
update(com.wewebu.ow.server.ui.OwEventTarget caller_p,
int iCode_p,
Object param_p)
causes all attached views to receive an onUpdate event
|
dispatch, getConfigNode, getConfiguration, getMasterView, getPersistentAttributeBagWriteable, getPlugin, getPluginID, getSafeSetting, setPlugin, setSafeSetting
attachView, attributecount, clear, detachView, getAttribute, getAttribute, getAttributeNames, getSafeAttribute, hasAttribute, remove, save, setAttribute
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
public static final String PLUGIN_LIST_ENABLED_ATTRIBUTE
public static final String PLUGIN_DOC_CONFIG_PARAMETER
public static final String SETTINGS_PARAM_COLUMN_INFO
public static final String SETTINGS_PARAM_SORT
public static final String CONFIG_NODE_DOCUMENTFUNCTIONPLUGINS
public static final String CONFIG_NODE_RECORDFUNCTIONPLUGINS
public static final String CONFIG_NODE_ENABLEDDOCUMENTFUNCTIONS
protected static final String CONFIG_NODE_SHOWFOLDERS
protected static final String CONFIG_NODE_PAGEABLE
protected static final String CONFIG_NODE_CLIENT_FILTER
public static final String CONFIG_NODE_USE_DYNAMIC_SPLIT
protected int m_iMaxSize
protected com.wewebu.ow.server.ecm.OwObject m_RootFolderObject
protected com.wewebu.ow.server.ecm.OwObject m_SubFolderObject
protected com.wewebu.ow.server.ecm.OwObject m_subFolderObjectParent
protected String m_strSubFolderPath
protected com.wewebu.ow.server.ui.OwTreeView m_ResultTreeView
protected List m_rulesList
getRulesList()
.public void enableSearchTemplateView(boolean enablesearchtemplateview_p)
public boolean isSearchTemplateViewEnabled()
public boolean isPropertyPreviewViewEnabled()
protected Collection getDefaultColumnInfo() throws Exception
Exception
public com.wewebu.ow.server.field.OwSearchTemplate getSearchTemplate() throws Exception
Exception
protected void init() throws Exception
init
in class com.wewebu.ow.server.app.OwMasterDocument
Exception
protected com.wewebu.ow.server.app.OwDynamicLayoutSettings createLayoutSettings() throws Exception
Exception
public boolean isDynamicSplitInUse() throws Exception
true
if the dynamic split is usedException
public int getMaxChildSize()
public void setMaxChildSize(int iMax_p)
iMax_p
- int max child sizepublic com.wewebu.ow.server.ecm.OwObject getCurrentRootFolder()
public com.wewebu.ow.server.ecm.OwObject getCurrentSubFolderObject()
public com.wewebu.ow.server.ecm.OwObject getCurrentSubFolderObjectParent()
null
if no parent is availablepublic String getCurrentSubFolderPath()
public String getCurrentSubFolderDisplayPath()
public void openFolder(com.wewebu.ow.server.ecm.OwObject folder_p, String strSubFolderPath_p) throws Exception
folder_p
- root folder OwObject
to displaystrSubFolderPath_p
- String path that designates a subfolder to open, can be null to open the rootException
public void setResultTreeView(com.wewebu.ow.server.ui.OwTreeView resultTreeView_p) throws Exception
resultTreeView_p
- OwObjectTreeViewException
public Object onDispatch(int iCode_p, Object param1_p, Object param2_p) throws Exception
onDispatch
in class com.wewebu.ow.server.app.OwMasterDocument
iCode_p
- enumerator designating the requested actionparam1_p
- Placeholder for optional parameterparam2_p
- Placeholder for optional parameterException
public void onTreeViewNavigateFolder(com.wewebu.ow.server.ui.OwTreeView.OwTreeViewNode node_p) throws Exception
onTreeViewNavigateFolder
in interface com.wewebu.ow.server.ui.OwTreeView.OwTreeViewEventListner
Exception
public void onTreeViewOpenFolder(com.wewebu.ow.server.ui.OwTreeView.OwTreeViewNode node_p) throws Exception
onTreeViewOpenFolder
in interface com.wewebu.ow.server.ui.OwTreeView.OwTreeViewEventListner
Exception
public boolean supportLock()
public void update(com.wewebu.ow.server.ui.OwEventTarget caller_p, int iCode_p, Object param_p) throws Exception
update
in class com.wewebu.ow.server.ui.OwDocument
caller_p
- OwEventTarget target that called updateiCode_p
- int optional reason codeparam_p
- Object optional parameter representing the refresh, depends on the value of iCode_p, can be nullException
protected com.wewebu.ow.server.collections.OwLoadContext getLoadContext() throws Exception
Exception
protected Collection<com.wewebu.ow.server.field.OwFieldDefinition> collectFilterProperties(Collection columnInfoList_p) throws Exception
columnInfoList_p
- Collection of OwFieldColumnInfo representing the column which should be shownException
protected boolean checkValidSearchCriteria()
public void onClientRefreshContextUpdate(int iReason_p, Object param_p) throws Exception
onClientRefreshContextUpdate
in interface com.wewebu.ow.server.app.OwClientRefreshContext
iReason_p
- reason as defined with OwFunction.REFRESH_...param_p
- Object optional parameter representing the refresh, depends on the value of iReason_p, can be nullException
public void onObjectListViewFilterChange(com.wewebu.ow.server.field.OwSearchNode filterNode_p, com.wewebu.ow.server.ecm.OwObject parent_p) throws Exception
onObjectListViewFilterChange
in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
Exception
public boolean onObjectListViewItemClick(com.wewebu.ow.server.ecm.OwObject obj_p) throws Exception
onObjectListViewItemClick
in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
Exception
public void onObjectListViewSelect(com.wewebu.ow.server.ecm.OwObject object_p, com.wewebu.ow.server.ecm.OwObject parent_p) throws Exception
onObjectListViewSelect
in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
Exception
public void onObjectListViewSort(com.wewebu.ow.server.field.OwSort newSort_p, String strSortProperty_p) throws Exception
onObjectListViewSort
in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
Exception
protected com.wewebu.ow.server.util.OwXMLUtil getDocumentFunctionPluginsNode() throws Exception
OwXMLUtil
Exception
protected com.wewebu.ow.server.util.OwXMLUtil getRecordFunctionPluginsNode() throws Exception
OwXMLUtil
nodeException
protected com.wewebu.ow.server.util.OwXMLUtil getDocumentFunctionsNode() throws Exception
Read the configuration tag: OwRecordDocument.CONFIG_NODE_ENABLEDDOCUMENTFUNCTIONS
OwXMLUtil
node or null if config element is missingException
protected boolean getIsPluginsEnabled() throws Exception
boolean
Exception
protected com.wewebu.ow.server.field.OwSort getFolderSortCriteria()
<FolderSortCriteria>
tag in owplugins.xml
.
If no criteria isn't defined the method will return an OwSort
object with no OwSort.OwSortCriteria
contained.
protected List getRulesList() throws Exception
OwPriorityRule
sException
- if the priority rules cannot be createdpublic String onObjectListViewGetRowClassName(int iIndex_p, com.wewebu.ow.server.ecm.OwObject obj_p)
onObjectListViewGetRowClassName
in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
iIndex_p
- int row indexobj_p
- current OwObjectprotected boolean showFolderInResultList()
false
)public String getTreeViewId()
OwTreeView
object.OwTreeView
object.public com.wewebu.ow.server.app.OwDynamicLayoutSettings getLayoutSettings()
OwDynamicLayoutSettings
instance.OwDynamicLayoutSettings
instance.protected OwRecordFilterOperatorHelper createFilterOperatorHelper()
public boolean isClientFilterEnabled()
public boolean isMaxSizeEnabled()
true
if show attribute of MaxSizeMax, show="true|false"
is true
, or false
if show
attribute is false
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.