public class OwSearchDocument
extends com.wewebu.ow.server.app.OwMasterDocument
implements com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
Search Document 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 | Class and Description |
---|---|
class |
OwSearchDocument.OwRepositorySearchTemplate
decorator class for search templates.
|
Modifier and Type | Field and Description |
---|---|
static String |
CONFIG_NODE_ENABLEDDOCUMENTFUNCTIONS
configuration node name <EnabledDocumentFunctions>
|
static String |
PLUGIN_LIST_ENABLED_ATTRIBUTE
enabled attribute for document function plugin list
|
Constructor and Description |
---|
OwSearchDocument() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
autoOpenFirstObject(com.wewebu.ow.server.ecm.OwObject obj_p,
int iSize_p)
(overridable) to check for auto open first one if one or more where found
|
boolean |
canGoBackToSearchTemplate()
check if navigate to the searchtemplate the caused the last search is possible
|
void |
doSearch(int iMaxListSize_p)
perform a search and display the result
|
void |
doSearch(int iMaxListSize_p,
com.wewebu.ow.server.field.OwSort sort)
perform a search and display the result
|
com.wewebu.ow.server.field.OwSearchTemplate |
getCurrentSearchTemplate()
get the active searchtemplate
|
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 |
getFilteredSort(com.wewebu.ow.server.field.OwSort sort_p,
Collection properties_p)
compute a filtered sort out of a given sort according to the given property list
used to adjust a sort created by the resultlist to the current search, which might be different to the last search
|
protected Map |
getRepositories()
overridable, create a map of repositories that can be searched
|
com.wewebu.ow.server.collections.OwIterable<com.wewebu.ow.server.ecm.OwObject> |
getResultIterable()
get the result collection
|
com.wewebu.ow.server.ecm.OwObjectCollection |
getResultList()
get the result collection
|
com.wewebu.ow.server.ecm.OwObject |
getResultObject(int index) |
int |
getResultSize() |
Collection |
getSearchTemplates()
get the list to the available searchtemplates, which are allowed for the user.
|
void |
goBackToSearchTemplate()
navigate to the searchtemplate the caused the last search
|
protected void |
init()
init the target after the context is set.
|
protected boolean |
isAutoOpenFirstDocument()
check if open first document is activated
|
protected boolean |
isAutoOpenSingleRecord()
check if open single record (folder) is activated
|
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) |
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 |
repeatLastSearch()
Repeats the last search performed through
doSearch(int) preserving the
current page in the object list view. |
void |
setNavigationView(com.wewebu.ow.server.ui.OwNavigationView navView_p)
set the currently used searchtemplate view which generated the result list
|
com.wewebu.ow.server.field.OwSearchTemplate |
setSearchTemplatName(String strSearchTemplateName_p)
set and activate the searchtemplate
|
dispatch, getConfigNode, getConfiguration, getMasterView, getPersistentAttributeBagWriteable, getPlugin, getPluginID, getSafeSetting, setPlugin, setSafeSetting
attachView, attributecount, clear, detachView, getAttribute, getAttribute, getAttributeNames, getSafeAttribute, hasAttribute, remove, save, setAttribute, update
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
public static final String CONFIG_NODE_ENABLEDDOCUMENTFUNCTIONS
public static final String PLUGIN_LIST_ENABLED_ATTRIBUTE
protected Map getRepositories()
protected void init() throws Exception
init
in class com.wewebu.ow.server.app.OwMasterDocument
Exception
public com.wewebu.ow.server.field.OwSearchTemplate setSearchTemplatName(String strSearchTemplateName_p) throws Exception
strSearchTemplateName_p
- Name of the template as retrieved from OwNetwork.getSiteObjects("SearchTemplates");Exception
public com.wewebu.ow.server.field.OwSearchTemplate getCurrentSearchTemplate() throws Exception
Exception
public Collection getSearchTemplates() throws Exception
Exception
protected com.wewebu.ow.server.field.OwSort getFilteredSort(com.wewebu.ow.server.field.OwSort sort_p, Collection properties_p)
sort_p
- an OwSort
objectproperties_p
- Properties to filter forpublic void setNavigationView(com.wewebu.ow.server.ui.OwNavigationView navView_p)
public boolean canGoBackToSearchTemplate()
public void goBackToSearchTemplate() throws Exception
Exception
public void doSearch(int iMaxListSize_p) throws Exception
iMaxListSize_p
- int maximum number of items in the searchException
public void doSearch(int iMaxListSize_p, com.wewebu.ow.server.field.OwSort sort) throws Exception
iMaxListSize_p
- int maximum number of items in the searchsort
- sorting rules to be used during searchException
public void repeatLastSearch() throws Exception
doSearch(int)
preserving the
current page in the object list view.Exception
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
- String Name of search template and max size to activate in the form "[templatename],[maxsize]"param2_p
- Map of values mapped to property names as search parametersException
public int getResultSize()
public com.wewebu.ow.server.ecm.OwObject getResultObject(int index)
index
- public com.wewebu.ow.server.collections.OwIterable<com.wewebu.ow.server.ecm.OwObject> getResultIterable()
OwIterable
public com.wewebu.ow.server.ecm.OwObjectCollection getResultList()
OwObjectCollection
protected boolean autoOpenFirstObject(com.wewebu.ow.server.ecm.OwObject obj_p, int iSize_p)
obj_p
- first OwObject to check if it should be auto openediSize_p
- int number of objects in the result listprotected boolean isAutoOpenSingleRecord()
protected boolean isAutoOpenFirstDocument()
protected com.wewebu.ow.server.util.OwXMLUtil getDocumentFunctionsNode() throws Exception
Read the configuration tag: OwSearchDocument.CONFIG_NODE_ENABLEDDOCUMENTFUNCTIONS
OwXMLUtil
node or null if config element is missingException
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 String onObjectListViewGetRowClassName(int iIndex_p, com.wewebu.ow.server.ecm.OwObject obj_p)
onObjectListViewGetRowClassName
in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner
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
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.