public abstract class ArticleSearchForm extends SearchForm
The abstract super class of all search forms used for searching articles.
Constructor and Description |
---|
ArticleSearchForm() |
Modifier and Type | Method and Description |
---|---|
String[] |
getArticleType()
Gets the article types to be included in the search.
|
String |
getDescending()
Gets the descending sort order.
|
protected boolean |
getDescendingSort()
Specify if the result should be sorted in descending order.
|
protected List |
getExcludeNodes()
The
Sections or
Catalogs to exclude in the search. |
String[] |
getExcludeSectionId()
Gets the list of excluded sections.
|
protected List |
getIncludeNodes()
The
Sections or
Catalogs to include in the search. |
String[] |
getIncludeSectionId()
Gets the sections to to include in the search.
|
String |
getIncludeSubSections()
Gets if we should include sub sections in the search.
|
String |
getMaxRows()
Gets the max rows.
|
protected int |
getMaxSearchRows()
The max number of rows to include in the search.
|
String |
getOptimized()
Gets the optimized property.
|
protected boolean |
getSearchSubNodes()
Should we include sub nodes in the search?
|
String |
getSearchType()
Gets the searchType.
|
List |
getSearchTypes()
A
List used to prepopulate the searchType
property. |
protected String |
getSortExpression()
How the result should be sorted.
|
String |
getSortString()
Gets the String used for sorting the result.
|
List |
getSortStrings()
A
List used to prepopulate the sortString
property. |
protected List |
getStates()
The states to include in the search.
|
String |
getStemType()
Gets the stem type property.
|
List |
getStemTypes()
|
protected List |
getTypes()
The types to include in the search.
|
protected void |
initParameters()
Initializes the parameters saved in the parameters list.
|
protected boolean |
isLive()
Limit the search to live objects.
|
void |
resetArticleType(org.apache.struts.action.ActionMapping pMapping,
javax.servlet.http.HttpServletRequest pRequest)
Resets the articleTypes property.
|
void |
resetDescending(org.apache.struts.action.ActionMapping pMapping,
javax.servlet.http.HttpServletRequest pRequest)
Resets the descending property.
|
void |
resetExcludeSectionId(org.apache.struts.action.ActionMapping pMapping,
javax.servlet.http.HttpServletRequest pRequest)
Resets the excludeSectionId property.
|
void |
resetIncludeSectionId(org.apache.struts.action.ActionMapping pMapping,
javax.servlet.http.HttpServletRequest pRequest)
Resets the includeSectionId property.
|
void |
resetIncludeSubSections(org.apache.struts.action.ActionMapping pMapping,
javax.servlet.http.HttpServletRequest pRequest)
Resets the includeSubSections property.
|
void |
resetSortString(org.apache.struts.action.ActionMapping pMapping,
javax.servlet.http.HttpServletRequest pRequest)
Resets the sortExpression property.
|
void |
setArticleType(String[] pArticleTypes)
Sets the article types to be included in the search.
|
void |
setDescending(String pSortOrder)
Sets the descending sort order.
|
void |
setExcludeSectionId(String[] pSectionIds)
Sets the list of excluded sections.
|
void |
setIncludeSectionId(String[] pSectionIds)
Sets the sections to to include in the search.
|
void |
setIncludeSubSections(String pIncludeSubSections)
Sets if we should include sub sections in the search.
|
void |
setMaxRows(String pHubba)
Sets the max rows.
|
void |
setOptimized(String pString)
Sets the optimized property
|
void |
setSearchType(String pString)
Sets the searchType.
|
void |
setSortString(String pSortString)
Sets the String used for sorting the result.
|
void |
setStemType(String pString)
Sets the stem type property.
|
void |
validateExcludeSectionId(org.apache.struts.action.ActionErrors pActionErrors)
Validates the excludeSectionId property.
|
void |
validateIncludeSectionId(org.apache.struts.action.ActionErrors pActionErrors)
Validates the includeSectionId property.
|
void |
validateIncludeSubSections(org.apache.struts.action.ActionErrors pActionErrors)
Validates the includeSubSections property.
|
void |
validateMaxRows(org.apache.struts.action.ActionErrors pActionErrors)
Validates the maxRows property.
|
void |
validateOptimized(org.apache.struts.action.ActionErrors pActionErrors)
Validates the optimized property.
|
allowReset, containsParameter, getErrorUrl, getFromDate, getPageLength, getPageLengthAsInt, getPageNumber, getPageNumberhAsInt, getParameter, getParameters, getPublicationId, getPublicationIdAsInt, getSearchEngineName, getSearchExpression, getSearchKey, getSearchKeyAsInt, getSuccessUrl, getToDate, reset, resetErrorUrl, resetParameters, resetSearchEngineName, resetSearchKey, resetTargetUrl, setErrorUrl, setPageLength, setPageNumber, setParameter, setPublicationId, setSearchEngineName, setSearchKey, setSuccessUrl, validatePageLength, validatePageNumber, validatePublicationId
addError, addError, addError, integer, minValue, range, required, validate
public String[] getIncludeSectionId()
public void setIncludeSectionId(String[] pSectionIds)
pSectionIds
- The sections to include in the search.public void resetIncludeSectionId(org.apache.struts.action.ActionMapping pMapping, javax.servlet.http.HttpServletRequest pRequest)
pMapping
- The mapping used to select this instance.pRequest
- The request we are processingpublic void validateIncludeSectionId(org.apache.struts.action.ActionErrors pActionErrors)
pActionErrors
- the ActionErrors
to add ActionError
to when we
discover validation errorsprotected List getIncludeNodes()
SearchForm
Sections
or
Catalogs
to include in the search.getIncludeNodes
in class SearchForm
unmodifiable
List
of Integers
.public String getIncludeSubSections()
public void setIncludeSubSections(String pIncludeSubSections)
pIncludeSubSections
- The includeSubSections to set.public void resetIncludeSubSections(org.apache.struts.action.ActionMapping pMapping, javax.servlet.http.HttpServletRequest pRequest)
pMapping
- The mapping used to select this instance.pRequest
- The request we are processingpublic void validateIncludeSubSections(org.apache.struts.action.ActionErrors pActionErrors)
pActionErrors
- the ActionErrors
to add ActionError
to when we
discover validation errorsprotected boolean getSearchSubNodes()
SearchForm
getSearchSubNodes
in class SearchForm
true
if we should include the sub nodes in search,
false
otherwise.public String[] getExcludeSectionId()
public void setExcludeSectionId(String[] pSectionIds)
pSectionIds
- public void resetExcludeSectionId(org.apache.struts.action.ActionMapping pMapping, javax.servlet.http.HttpServletRequest pRequest)
pMapping
- The mapping used to select this instance.pRequest
- The request we are processingpublic void validateExcludeSectionId(org.apache.struts.action.ActionErrors pActionErrors)
pActionErrors
- the ActionErrors
to add ActionError
to when we
discover validation errorsprotected List getExcludeNodes()
SearchForm
Sections
or
Catalogs
to exclude in the search.getExcludeNodes
in class SearchForm
unmodifiable
List
of Integers
.public String[] getArticleType()
public void setArticleType(String[] pArticleTypes)
pArticleTypes
- the article types to be includedpublic void resetArticleType(org.apache.struts.action.ActionMapping pMapping, javax.servlet.http.HttpServletRequest pRequest)
pMapping
- The mapping used to select this instance.pRequest
- The request we are processingprotected List getTypes()
SearchForm
articles
this will be the article type. For
ReferenceEntity
objects this will be Image
,
Link
,Media
or Person
.getTypes
in class SearchForm
null
.protected List getStates()
SearchForm
articles
the states would be:
draft
, submitted
, approved
,
published
or deleted
.getStates
in class SearchForm
null
.protected boolean isLive()
SearchForm
isLive
in class SearchForm
true
when limited to only to include only live
articles, false
otherwise.public String getSortString()
public void setSortString(String pSortString)
pSortString
- the expression used in sorting.public void resetSortString(org.apache.struts.action.ActionMapping pMapping, javax.servlet.http.HttpServletRequest pRequest)
pMapping
- The mapping used to select this instance.pRequest
- The request we are processingpublic List getSortStrings()
List
used to prepopulate the sortString
property.unmodifiable
List
of LabelValueBeans
.protected String getSortExpression()
SearchForm
getSortExpression
in class SearchForm
public String getDescending()
public void setDescending(String pSortOrder)
pSortOrder
- the sort order.public void resetDescending(org.apache.struts.action.ActionMapping pMapping, javax.servlet.http.HttpServletRequest pRequest)
pMapping
- The mapping used to select this instance.pRequest
- The request we are processingprotected boolean getDescendingSort()
SearchForm
getDescendingSort
in class SearchForm
true
if sorting in descending order,
false
otherwise.public String getMaxRows()
public void setMaxRows(String pHubba)
pHubba
- public void validateMaxRows(org.apache.struts.action.ActionErrors pActionErrors)
pActionErrors
- the ActionErrors
to add ActionError
to when we
discover validation errorsprotected int getMaxSearchRows()
SearchForm
getMaxSearchRows
in class SearchForm
protected void initParameters()
SearchForm
super.initParameters()
.initParameters
in class SearchForm
public String getSearchType()
public void setSearchType(String pString)
pString
- the search type to usepublic List getSearchTypes()
List
used to prepopulate the searchType
property.unmodifiable
List
of LabelValueBeans
.public String getOptimized()
public void setOptimized(String pString)
pString
- The valuepublic void validateOptimized(org.apache.struts.action.ActionErrors pActionErrors)
pActionErrors
- the ActionErrors
to add ActionError
to when we
discover validation errorspublic String getStemType()
public void setStemType(String pString)
pString
- the stem type name to use.public List getStemTypes()
unmodifiable
List
of LabelValueBeans
.© 1998- 2021 Escenic AS