|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.wewebu.ow.server.ui.OwEventTarget
com.wewebu.ow.server.ui.OwDocument
com.wewebu.ow.server.app.OwMasterDocument
com.wewebu.ow.server.plug.owsearch.OwSearchDocument
public class OwSearchDocument
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
Nested Class Summary | |
---|---|
class |
OwSearchDocument.OwRepositorySearchTemplate
decorator class for search templates. |
Field Summary | |
---|---|
static String |
CONFIG_NODE_ENABLEDDOCUMENTFUNCTIONS
configuration node name <EnabledDocumentFunctions> |
static String |
PLUGIN_LIST_ENABLED_ATTRIBUTE
enabled attribute for document function plugin list |
Fields inherited from class com.wewebu.ow.server.ui.OwDocument |
---|
m_ViewList |
Constructor Summary | |
---|---|
OwSearchDocument()
|
Method Summary | |
---|---|
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 |
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.ecm.OwObjectCollection |
getResultList()
get the result collection |
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 |
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 |
Methods inherited from class com.wewebu.ow.server.app.OwMasterDocument |
---|
dispatch, getConfigNode, getConfiguration, getMasterView, getPersistentAttributeBagWriteable, getPlugin, getPluginID, getSafeSetting, setPlugin, setSafeSetting |
Methods inherited from class com.wewebu.ow.server.ui.OwDocument |
---|
attachView, attributecount, clear, detachView, getAttribute, getAttribute, getAttributeNames, getSafeAttribute, hasAttribute, remove, save, setAttribute, update |
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget |
---|
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CONFIG_NODE_ENABLEDDOCUMENTFUNCTIONS
public static final String PLUGIN_LIST_ENABLED_ATTRIBUTE
Constructor Detail |
---|
public OwSearchDocument()
Method Detail |
---|
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 for
public 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 search
Exception
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 parameters
Exception
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 list
protected 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 missing
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |