public interface OwSearchTemplate extends OwFieldProvider
Object Wrapper for XML Search Templates.
Parses Search Objects to create search forms and holds formating information for the search results.
To be implemented by the DMS Adaptor.
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 |
---|---|
static int |
VERSION_SELECT_ALL
type of versions to search for all versions
|
static int |
VERSION_SELECT_CHECKED_OUT
type of versions to search for the checked out version
|
static int |
VERSION_SELECT_CURRENT
type of versions to search for the current or latest version
|
static int |
VERSION_SELECT_DEFAULT
type of versions to search for
|
static int |
VERSION_SELECT_IN_PROCESS
type of versions to search for the in process versions
|
static int |
VERSION_SELECT_MAJORS
type of versions to search for all major versions
|
static int |
VERSION_SELECT_MINORS
type of versions to search for all minor versions
|
static int |
VERSION_SELECT_RELEASED
type of versions to search for the released version
|
TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL
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
|
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
|
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
|
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
|
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
|
void |
saveSearch(String name_p)
save the current search
|
void |
setSavedSearch(String name_p)
init the search template with a saved search
|
getField, getFieldProviderName, getFieldProviderSource, getFieldProviderType, getFields, getSafeFieldValue, setField
static final int VERSION_SELECT_DEFAULT
static final int VERSION_SELECT_RELEASED
static final int VERSION_SELECT_ALL
static final int VERSION_SELECT_CURRENT
static final int VERSION_SELECT_MAJORS
static final int VERSION_SELECT_MINORS
static final int VERSION_SELECT_IN_PROCESS
static final int VERSION_SELECT_CHECKED_OUT
void init(OwFieldDefinitionProvider fieldDefinitionProvider_p) throws Exception
fieldDefinitionProvider_p
- OwFieldDefinitionProvider to resolve fieldsException
Collection getColumnInfoList() throws Exception
Exception
OwSearchNode getSearch(boolean fRefresh_p) throws Exception
fRefresh_p
- true = reload search from template, false = get cached searchException
String getHtmlLayout()
boolean hasHtmlLayout()
String getJspLayoutPage()
boolean hasJspLayoutPage()
String getIcon()
String getName()
String getDisplayName(Locale locale_p)
locale_p
- Locale to useint getVersionSelection()
OwSort getSort(int iMinSortCriteria_p)
iMinSortCriteria_p
- int min number of sort criteria that the returned sort should supportOwPriorityRule getPriorityRule()
boolean isInitalized()
int getDefaultMaxSize()
boolean canSaveSearch()
boolean canDeleteSearch()
boolean canUpdateSearch()
void deleteSavedSearch(String name_p) throws Exception
name_p
- Exception
Collection getSavedSearches() throws Exception
Exception
void setSavedSearch(String name_p) throws Exception
name_p
- Exception
String getSavedSearch() throws Exception
Exception
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.