public interface WebContentFilter extends ContentFilter
Modifier and Type | Interface and Description |
---|---|
static class |
WebContentFilter.AccessLimitation
The access limitation policy.
|
static class |
WebContentFilter.Context
The search context
|
static interface |
WebContentFilter.FilterSearchContext
Interface representing a filter search context.
|
ContentFilter.Condition, ContentFilter.ContextLanguage
Modifier and Type | Method and Description |
---|---|
WebContentFilter.FilterSearchContext |
addSearchContext()
Add a search context.
|
WebContentFilter.AccessLimitation |
getAccessLimitation()
Determines the access limitation policy.
|
I18nizableText |
getDescription()
Get the filter's description
|
AmetysObjectIterable<Content> |
getMatchingContents(String siteName,
String lang,
Page page)
Get the contents matching this filter.<br/>
In most cases, the results will need to be re-filtered by the
ContentFilterHelper.isContentValid(org.ametys.cms.repository.Content, org.ametys.web.repository.page.Page, org.ametys.cms.filter.ContentFilter) method. |
List<WebContentFilter.FilterSearchContext> |
getSearchContexts()
Get the list of search contexts.
|
I18nizableText |
getTitle()
Get the filter's title
|
boolean |
maskOrphanContents()
Determines if orphan contents must be masked
|
void |
setAccessLimitation(WebContentFilter.AccessLimitation limitation)
Set the access limitation policy.
|
void |
setDescription(I18nizableText description)
Set the filter's description
|
void |
setMaskOrphanContents(boolean mask)
Set if orphan contents must be masked
|
void |
setTitle(I18nizableText title)
Set the filter's title
|
addContentType, addMetadata, addSortCriteria, getAdditionalFilterExpression, getContentTypes, getContextLanguage, getId, getLength, getMatchingContents, getMatchingContents, getMetadataCondition, getMetadataValues, getSortCriteria, getView, setAdditionalFilterExpression, setContextLanguage, setId, setLength, setMetadataCondition, setResolver, setView
I18nizableText getTitle()
I18nizableText getDescription()
void setTitle(I18nizableText title)
title
- The title to setvoid setDescription(I18nizableText description)
description
- The description to setList<WebContentFilter.FilterSearchContext> getSearchContexts()
WebContentFilter.FilterSearchContext addSearchContext()
void setMaskOrphanContents(boolean mask)
mask
- true to mask orphan contentsboolean maskOrphanContents()
WebContentFilter.AccessLimitation getAccessLimitation()
void setAccessLimitation(WebContentFilter.AccessLimitation limitation)
limitation
- the access limitation policy to set.AmetysObjectIterable<Content> getMatchingContents(String siteName, String lang, Page page)
ContentFilterHelper.isContentValid(org.ametys.cms.repository.Content, org.ametys.web.repository.page.Page, org.ametys.cms.filter.ContentFilter)
method.siteName
- The current site name. Can be null.lang
- The current language. Can be null.page
- The current page. Can be null.ContentFilterHelper.isContentValid(Content, Page, ContentFilter)