com.wewebu.ow.server.ecm

Class OwStandardVirtualFolderObjectFactory.OwSearchTemplateWrapper

java.lang.Object

com.wewebu.ow.server.ecm.OwStandardVirtualFolderObjectFactory.OwSearchTemplateWrapper

All Implemented Interfaces:

OwFieldProvider, OwSearchTemplate

Enclosing class:

OwStandardVirtualFolderObjectFactory

protected static class OwStandardVirtualFolderObjectFactory.OwSearchTemplateWrapper
extends Object
implements OwSearchTemplate

Helper to identify if a refresh/reset of the searchtemplate was processed or not.

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

Since:

4.1.2

Field Summary

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

VERSION_SELECT_ALL, VERSION_SELECT_CHECKED_OUT, VERSION_SELECT_CURRENT, VERSION_SELECT_DEFAULT, VERSION_SELECT_IN_PROCESS, VERSION_SELECT_MAJORS, VERSION_SELECT_MINORS, VERSION_SELECT_RELEASED

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

Constructor Summary

Constructors

Constructor and Description
OwStandardVirtualFolderObjectFactory.OwSearchTemplateWrapper(OwSearchTemplate template)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDeleteSearch() check if saved searches can be deleted
boolean	canSaveSearch() check if searches can be saved
boolean	canUpdateSearch() check if saved searches can be updated
void	deleteSavedSearch(String name_p) delete the saved search
boolean	equals(Object obj)
Collection	getColumnInfoList() get the list of the column info tuple, which describe the result view
int	getDefaultMaxSize() get the default value for the maximum size of results or 0 if not defined
String	getDisplayName(Locale locale_p) get the template name, MUST be available before calling init
OwField	getField(String strFieldClassName_p) get a field with the given field definition class name
String	getFieldProviderName() get a name that identifies the field provider, e.g.
Object	getFieldProviderSource() get the source object that originally provided the fields.
int	getFieldProviderType() get the type of field provider can be one or more of TYPE_...
Collection	getFields() get all the properties in the form
String	getHtmlLayout() get the optional HTML layout associated with this template
String	getIcon() get a optional icon to be displayed with the search template, MUST be available before calling init
String	getJspLayoutPage() get the optional JSP layout page associated with this template
String	getName() get the template name, MUST be available before calling init
OwPriorityRule	getPriorityRule() get a priority rule for priority
Object	getSafeFieldValue(String sName_p, Object defaultvalue_p) retrieve the value of a Field
String	getSavedSearch() get the name of the current set search, or null if no saved search is set
Collection	getSavedSearches() get a collection of saved searches names
OwSearchNode	getSearch(boolean fRefresh_p) get the search tree created out of the template
OwSort	getSort(int iMinSortCriteria_p) get the sort to use for the result list
OwSearchTemplate	getTemplate()
int	getVersionSelection() get the version selection type
boolean	hasHtmlLayout() check if the optional HTML layout is available
boolean	hasJspLayoutPage() check if the optional JSP layout page is available
void	init(OwFieldDefinitionProvider fieldDefinitionProvider_p) init the search template so that the specified fields can be resolved
boolean	isInitalized() check if search template is already initialized
boolean	isReseted()
void	saveSearch(String name_p) save the current search
void	setField(String sName_p, Object value_p) modify a Field value, but does not save the value right away
void	setReseted(boolean rested)
void	setSavedSearch(String name_p) init the search template with a saved search

Methods inherited from class java.lang.Object

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

Constructor Detail

OwStandardVirtualFolderObjectFactory.OwSearchTemplateWrapper

public OwStandardVirtualFolderObjectFactory.OwSearchTemplateWrapper(OwSearchTemplate template)

Method Detail

getField

public OwField getField(String strFieldClassName_p)
                 throws Exception,
                        OwObjectNotFoundException

Description copied from interface: OwFieldProvider

get a field with the given field definition class name

Specified by:

getField in interface OwFieldProvider

Parameters:

strFieldClassName_p - String class name of requested fields

Returns:

OwField or throws OwObjectNotFoundException

Throws:

Exception

OwObjectNotFoundException

setField

public void setField(String sName_p,
            Object value_p)
              throws Exception,
                     OwObjectNotFoundException

Description copied from interface: OwFieldProvider

modify a Field value, but does not save the value right away

Specified by:

setField in interface OwFieldProvider

Throws:

Exception

OwObjectNotFoundException

getSafeFieldValue

public Object getSafeFieldValue(String sName_p,
                       Object defaultvalue_p)

Description copied from interface: OwFieldProvider

retrieve the value of a Field

Specified by:

getSafeFieldValue in interface OwFieldProvider

Returns:

Object the value of the Field of defaultvalue_p

getFields

public Collection getFields()
                     throws Exception

Description copied from interface: OwFieldProvider

get all the properties in the form

Specified by:

getFields in interface OwFieldProvider

Returns:

Collection of OwField

Throws:

Exception

getFieldProviderType

public int getFieldProviderType()

Description copied from interface: OwFieldProvider

get the type of field provider can be one or more of TYPE_...

Specified by:

getFieldProviderType in interface OwFieldProvider

getFieldProviderSource

public Object getFieldProviderSource()

Description copied from interface: OwFieldProvider

get the source object that originally provided the fields. e.g. the fieldprovider might be a template pattern implementation like a view, where the original provider would still be an OwObject

Specified by:

getFieldProviderSource in interface OwFieldProvider

Returns:

Object the original source object where the fields have been taken, can be a this pointer or null

getFieldProviderName

public String getFieldProviderName()

Description copied from interface: OwFieldProvider

get a name that identifies the field provider, e.g. the name of the underlying JSP page

Specified by:

getFieldProviderName in interface OwFieldProvider

Returns:

String unique ID / Name of fieldprovider, or null

init

public void init(OwFieldDefinitionProvider fieldDefinitionProvider_p)
          throws Exception

Description copied from interface: OwSearchTemplate

init the search template so that the specified fields can be resolved

Specified by:

init in interface OwSearchTemplate

Parameters:

fieldDefinitionProvider_p - OwFieldDefinitionProvider to resolve fields

Throws:

Exception

getColumnInfoList

public Collection getColumnInfoList()
                             throws Exception

Description copied from interface: OwSearchTemplate

get the list of the column info tuple, which describe the result view

Specified by:

getColumnInfoList in interface OwSearchTemplate

Returns:

Collection of OwFieldColumnInfo items

Throws:

Exception

getSearch

public OwSearchNode getSearch(boolean fRefresh_p)
                       throws Exception

Description copied from interface: OwSearchTemplate

get the search tree created out of the template

Specified by:

getSearch in interface OwSearchTemplate

Parameters:

fRefresh_p - true = reload search from template, false = get cached search

Returns:

OwSearchNode the search tree created out of the template

Throws:

Exception

getHtmlLayout

public String getHtmlLayout()

Description copied from interface: OwSearchTemplate

get the optional HTML layout associated with this template

Specified by:

getHtmlLayout in interface OwSearchTemplate

Returns:

String containing a HTML fragment with place holders for the search parameters of the form {##}, or null if not available

hasHtmlLayout

public boolean hasHtmlLayout()

Description copied from interface: OwSearchTemplate

check if the optional HTML layout is available

Specified by:

hasHtmlLayout in interface OwSearchTemplate

Returns:

true if a HTML layout is available via getHtmlLayout

getJspLayoutPage

public String getJspLayoutPage()

Description copied from interface: OwSearchTemplate

get the optional JSP layout page associated with this template

Specified by:

getJspLayoutPage in interface OwSearchTemplate

Returns:

String containing a JSP page name, or null if it is not available

hasJspLayoutPage

public boolean hasJspLayoutPage()

Description copied from interface: OwSearchTemplate

check if the optional JSP layout page is available

Specified by:

hasJspLayoutPage in interface OwSearchTemplate

Returns:

true if a JSP layout page is available via getJspLayoutPage

getIcon

public String getIcon()

Description copied from interface: OwSearchTemplate

get a optional icon to be displayed with the search template, MUST be available before calling init

Specified by:

getIcon in interface OwSearchTemplate

Returns:

String icon path relative to //, or null if no icon is defined

getName

public String getName()

Description copied from interface: OwSearchTemplate

get the template name, MUST be available before calling init

Specified by:

getName in interface OwSearchTemplate

Returns:

name of the template

getDisplayName

public String getDisplayName(Locale locale_p)

Description copied from interface: OwSearchTemplate

get the template name, MUST be available before calling init

Specified by:

getDisplayName in interface OwSearchTemplate

Parameters:

locale_p - Locale to use

Returns:

displayname of the template

getVersionSelection

public int getVersionSelection()

Description copied from interface: OwSearchTemplate

get the version selection type

Specified by:

getVersionSelection in interface OwSearchTemplate

Returns:

int types of versions to search for as defined with VERSION_SELECT_...

getSort

public OwSort getSort(int iMinSortCriteria_p)

Description copied from interface: OwSearchTemplate

get the sort to use for the result list

Specified by:

getSort in interface OwSearchTemplate

Parameters:

iMinSortCriteria_p - int min number of sort criteria that the returned sort should support

Returns:

OwSort the number of max sort criteria can be higher than iMaxSortCriteria_p but not less

getPriorityRule

public OwPriorityRule getPriorityRule()

Description copied from interface: OwSearchTemplate

get a priority rule for priority

Specified by:

getPriorityRule in interface OwSearchTemplate

Returns:

OwPriorityRule or null if undefined

isInitalized

public boolean isInitalized()

Description copied from interface: OwSearchTemplate

check if search template is already initialized

Specified by:

isInitalized in interface OwSearchTemplate

Returns:

boolean true = template is initialized already, false = init was not called yet.

getDefaultMaxSize

public int getDefaultMaxSize()

Description copied from interface: OwSearchTemplate

get the default value for the maximum size of results or 0 if not defined

Specified by:

getDefaultMaxSize in interface OwSearchTemplate

Returns:

int

canSaveSearch

public boolean canSaveSearch()

Description copied from interface: OwSearchTemplate

check if searches can be saved

Specified by:

canSaveSearch in interface OwSearchTemplate

canDeleteSearch

public boolean canDeleteSearch()

Description copied from interface: OwSearchTemplate

check if saved searches can be deleted

Specified by:

canDeleteSearch in interface OwSearchTemplate

canUpdateSearch

public boolean canUpdateSearch()

Description copied from interface: OwSearchTemplate

check if saved searches can be updated

Specified by:

canUpdateSearch in interface OwSearchTemplate

deleteSavedSearch

public void deleteSavedSearch(String name_p)
                       throws Exception

Description copied from interface: OwSearchTemplate

delete the saved search

Specified by:

deleteSavedSearch in interface OwSearchTemplate

Throws:

Exception

getSavedSearches

public Collection getSavedSearches()
                            throws Exception

Description copied from interface: OwSearchTemplate

get a collection of saved searches names

Specified by:

getSavedSearches in interface OwSearchTemplate

Returns:

Collection of String names, or null if nothing is available

Throws:

Exception

setSavedSearch

public void setSavedSearch(String name_p)
                    throws Exception

Description copied from interface: OwSearchTemplate

init the search template with a saved search

Specified by:

setSavedSearch in interface OwSearchTemplate

Throws:

Exception

getSavedSearch

public String getSavedSearch()
                      throws Exception

Description copied from interface: OwSearchTemplate

get the name of the current set search, or null if no saved search is set

Specified by:

getSavedSearch in interface OwSearchTemplate

Throws:

Exception

saveSearch

public void saveSearch(String name_p)
                throws Exception

Description copied from interface: OwSearchTemplate

save the current search

Specified by:

saveSearch in interface OwSearchTemplate

Throws:

Exception

isReseted

public boolean isReseted()

setReseted

public void setReseted(boolean rested)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getTemplate

public OwSearchTemplate getTemplate()