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
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
TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL
Constructor and Description |
---|
OwStandardVirtualFolderObjectFactory.OwSearchTemplateWrapper(OwSearchTemplate template) |
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
|
public OwStandardVirtualFolderObjectFactory.OwSearchTemplateWrapper(OwSearchTemplate template)
public OwField getField(String strFieldClassName_p) throws Exception, OwObjectNotFoundException
OwFieldProvider
getField
in interface OwFieldProvider
strFieldClassName_p
- String class name of requested fieldsException
OwObjectNotFoundException
public void setField(String sName_p, Object value_p) throws Exception, OwObjectNotFoundException
OwFieldProvider
setField
in interface OwFieldProvider
Exception
OwObjectNotFoundException
public Object getSafeFieldValue(String sName_p, Object defaultvalue_p)
OwFieldProvider
getSafeFieldValue
in interface OwFieldProvider
public Collection getFields() throws Exception
OwFieldProvider
getFields
in interface OwFieldProvider
Exception
public int getFieldProviderType()
OwFieldProvider
getFieldProviderType
in interface OwFieldProvider
public Object getFieldProviderSource()
OwFieldProvider
getFieldProviderSource
in interface OwFieldProvider
public String getFieldProviderName()
OwFieldProvider
getFieldProviderName
in interface OwFieldProvider
public void init(OwFieldDefinitionProvider fieldDefinitionProvider_p) throws Exception
OwSearchTemplate
init
in interface OwSearchTemplate
fieldDefinitionProvider_p
- OwFieldDefinitionProvider to resolve fieldsException
public Collection getColumnInfoList() throws Exception
OwSearchTemplate
getColumnInfoList
in interface OwSearchTemplate
Exception
public OwSearchNode getSearch(boolean fRefresh_p) throws Exception
OwSearchTemplate
getSearch
in interface OwSearchTemplate
fRefresh_p
- true = reload search from template, false = get cached searchException
public String getHtmlLayout()
OwSearchTemplate
getHtmlLayout
in interface OwSearchTemplate
public boolean hasHtmlLayout()
OwSearchTemplate
hasHtmlLayout
in interface OwSearchTemplate
public String getJspLayoutPage()
OwSearchTemplate
getJspLayoutPage
in interface OwSearchTemplate
public boolean hasJspLayoutPage()
OwSearchTemplate
hasJspLayoutPage
in interface OwSearchTemplate
public String getIcon()
OwSearchTemplate
getIcon
in interface OwSearchTemplate
public String getName()
OwSearchTemplate
getName
in interface OwSearchTemplate
public String getDisplayName(Locale locale_p)
OwSearchTemplate
getDisplayName
in interface OwSearchTemplate
locale_p
- Locale to usepublic int getVersionSelection()
OwSearchTemplate
getVersionSelection
in interface OwSearchTemplate
public OwSort getSort(int iMinSortCriteria_p)
OwSearchTemplate
getSort
in interface OwSearchTemplate
iMinSortCriteria_p
- int min number of sort criteria that the returned sort should supportpublic OwPriorityRule getPriorityRule()
OwSearchTemplate
getPriorityRule
in interface OwSearchTemplate
public boolean isInitalized()
OwSearchTemplate
isInitalized
in interface OwSearchTemplate
public int getDefaultMaxSize()
OwSearchTemplate
getDefaultMaxSize
in interface OwSearchTemplate
public boolean canSaveSearch()
OwSearchTemplate
canSaveSearch
in interface OwSearchTemplate
public boolean canDeleteSearch()
OwSearchTemplate
canDeleteSearch
in interface OwSearchTemplate
public boolean canUpdateSearch()
OwSearchTemplate
canUpdateSearch
in interface OwSearchTemplate
public void deleteSavedSearch(String name_p) throws Exception
OwSearchTemplate
deleteSavedSearch
in interface OwSearchTemplate
Exception
public Collection getSavedSearches() throws Exception
OwSearchTemplate
getSavedSearches
in interface OwSearchTemplate
Exception
public void setSavedSearch(String name_p) throws Exception
OwSearchTemplate
setSavedSearch
in interface OwSearchTemplate
Exception
public String getSavedSearch() throws Exception
OwSearchTemplate
getSavedSearch
in interface OwSearchTemplate
Exception
public void saveSearch(String name_p) throws Exception
OwSearchTemplate
saveSearch
in interface OwSearchTemplate
Exception
public boolean isReseted()
public void setReseted(boolean rested)
public OwSearchTemplate getTemplate()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.