All Superinterfaces:

DelegatedControllerAware, Element, MediaCollectionElement, Presentable, Wrapper
```
@Indexable
public interface MediaCollectionOverviewElement
extends MediaCollectionElement
```
Collection of MediaItems. This element can be created via the ElementManagementService.

Nested Class Summary
- Nested classes/interfaces inherited from interface nl.gx.webmanager.cms.mediarepository.MediaCollectionElement
  MediaCollectionElement.TargetType

Field Summary

Fields
Modifier and Type Field Description

static String DEFAULT_FALLBACK_STRATEGY

static String FALLBACK_LANGUAGE

static String IGNORE_FALLBACK_LANGUAGE

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addContentType(MediaContentType mediaContentType)`	Adds a contenttype to the element.
`void`	`addExcludingTerm(MediaTerm mediaTerm)`	Add a excluding term to the element.
`void`	`addMandatoryTerm(MediaTerm mediaTerm)`	Add a mandatory term to the element.
`void`	`addOptionalTerm(MediaTerm mediaTerm)`	Add a optional term to the element.
`String`	`getContentDependentOperator()`	Deprecated. Use getContentRelatedOperator instead, which returns a the operator as an enum value instead of a String
`ContentRelatedOperator`	`getContentRelatedOperator()`	Returns the content related operator to use in this overview.
`MediaContentType[]`	`getContentTypes()`	Returns the contenttypes of the element
`MediaTerm[]`	`getExcludingTerms()`	Returns the excluding terms of the element
`String`	`getFallbackLanguage()`	Returns the fallback language option selected for the element.
`Date`	`getFromDate()`	Returns the from date for selecting mediaitems
`MediaTerm[]`	`getIncludingTerms()`	Deprecated.
`int`	`getLastNumberOfDays()`	Returns how many days content may be
`MediaTerm[]`	`getMandatoryTerms()`	Returns the mandatory terms of the element
`int`	`getMaximumNumberOfItems()`	Returns how many items maximum need to be shown.
`MediaTerm[]`	`getOptionalTerms()`	Returns the optional terms of the element
`int`	`getShowResultsFrom()`	Returns the value of the 'show results from' field of the Media Overview.
`int`	`getShowResultsTo()`	Returns the value of the 'show results to' field of the Media Overview.
`MediaItemSortOptions`	`getSortOptions()`	Returns the selected MediaCollectionElementSortOptions.
`Date`	`getToDate()`	Returns the to date for selecting mediaitems.
`boolean`	`isContentDependent()`	Returns if the mediaitems should be content dependent.
`boolean`	`isTypeOfPageDependent()`	Returns if the mediaitems should be type of page dependent.
`boolean`	`isUseDateFromTo()`	Returns if the useDateFromTo should be used as base for narrowing selection
`boolean`	`isUseLastXDays()`	Returns if the lastXDays should be used as base for narrowing selection
`boolean`	`isUseTermRelations()`	Returns if term relations via the thesaurus should be used to find mediaitems
`void`	`removeContentType(MediaContentType mediaContentType)`	Removes a contenttype from the element.
`void`	`removeExcludingTerm(MediaTerm mediaTerm)`	Remove excluding term to the element.
`void`	`removeMandatoryTerm(MediaTerm mediaTerm)`	Remove mandatory term to the element.
`void`	`removeOptionalTerm(MediaTerm mediaTerm)`	Remove optional term to the element.
`void`	`setContentDependent(boolean isContentDependent)`	Sets if the mediaitems should be content dependent.
`void`	`setContentRelatedOperator(ContentRelatedOperator operator)`	Sets the content related operator to use in this overview.
`void`	`setFallbackLanguage(String language)`	Sets the fallback language for the element.
`void`	`setFromDate(Date date)`	Sets the from date for selecting mediaitems.
`void`	`setLastNumberOfDays(int lastNumberOfDays)`	Sets how many days content may be shown.
`void`	`setMaximumNumberOfItems(int maximumNumberOfItems)`	Sets how many items maximum need to be shown.
`void`	`setShowResultsFrom(int showResultsFrom)`	Sets the value of the 'show results from' field of the Media Overview.
`void`	`setShowResultsTo(int showResultsTo)`	Sets the value of the 'show results to' field of the Media Overview.
`void`	`setSortOptions(MediaItemSortOptions mediaItemSortOptions)`	Sets the selected MediaItemSortOptions.
`void`	`setToDate(Date date)`	Sets the to date for selecting mediaitems.
`void`	`setTypeOfPageDependent(boolean isTypeOfPageDependent)`	Sets if the mediaitems should be type of page dependent.
`void`	`setUseDateFromTo(boolean useDateFromTo)`	Sets if the dateFromTo should be used as base for narrowing selection.
`void`	`setUseLastXDays(boolean useLastXDays)`	Sets if the lastXDays should be used as base for narrowing selection.
`void`	`setUseTermRelations(boolean useTermRelations)`	Sets if term relations via the thesaurus should be used to find mediaitems.

Methods inherited from interface nl.gx.webmanager.springmvc.DelegatedControllerAware
getDelegatedController, setDelegatedController

Methods inherited from interface nl.gx.webmanager.cms.mediarepository.MediaCollectionElement
appendMediaItem, getAlternativeTargetPage, getMediaItems, getMediaItemVersions, getNumberOfMediaItems, getTargetType, getTitle, insertMediaItem, isShownOnCurrentPage, removeMediaItem, setAlternativeTargetPage, setMediaItems, setTargetType, setTitle

Methods inherited from interface nl.gx.webmanager.cms.core.Presentable
getPresentation, getPresentationVariant, render, render, setPresentation, setPresentationVariant

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper
getUUID, setId, setUUID

- Field Detail
  - DEFAULT_FALLBACK_STRATEGY
```
static final String DEFAULT_FALLBACK_STRATEGY
```
    See Also:
    
    Constant Field Values
  - FALLBACK_LANGUAGE
```
static final String FALLBACK_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - IGNORE_FALLBACK_LANGUAGE
```
static final String IGNORE_FALLBACK_LANGUAGE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getExcludingTerms
```
MediaTerm[] getExcludingTerms()
```
    Returns the excluding terms of the element
    
    Returns:
    
    array of MediaTerm
  - addExcludingTerm
```
void addExcludingTerm(MediaTerm mediaTerm)
```
    Add a excluding term to the element.
    
    Parameters:
    
    mediaTerm - the MediaTerm to be added
  - removeExcludingTerm
```
void removeExcludingTerm(MediaTerm mediaTerm)
```
    Remove excluding term to the element.
    
    Parameters:
    
    mediaTerm - the MediaTerm to be removed
  - getIncludingTerms
```
@Deprecated
MediaTerm[] getIncludingTerms()
```
    Deprecated.
    
    Returns the including terms of the element
    
    Returns:
    
    array of MediaTerm
  - getMandatoryTerms
```
@ReferDocument(inheritLanguage=true)
MediaTerm[] getMandatoryTerms()
```
    Returns the mandatory terms of the element
    
    Returns:
    
    array of MediaTerm
  - addMandatoryTerm
```
void addMandatoryTerm(MediaTerm mediaTerm)
```
    Add a mandatory term to the element.
    
    Parameters:
    
    mediaTerm - the MediaTerm to be added
  - removeMandatoryTerm
```
void removeMandatoryTerm(MediaTerm mediaTerm)
```
    Remove mandatory term to the element.
    
    Parameters:
    
    mediaTerm - the MediaTerm to be removed
  - getOptionalTerms
```
@ReferDocument(inheritLanguage=true)
MediaTerm[] getOptionalTerms()
```
    Returns the optional terms of the element
    
    Returns:
    
    array of MediaTerm
  - addOptionalTerm
```
void addOptionalTerm(MediaTerm mediaTerm)
```
    Add a optional term to the element.
    
    Parameters:
    
    mediaTerm - the MediaTerm to be added
  - removeOptionalTerm
```
void removeOptionalTerm(MediaTerm mediaTerm)
```
    Remove optional term to the element.
    
    Parameters:
    
    mediaTerm - the MediaTerm to be removed
  - getContentTypes
```
MediaContentType[] getContentTypes()
```
    Returns the contenttypes of the element
    
    Returns:
    
    array of contenttype id's
  - addContentType
```
void addContentType(MediaContentType mediaContentType)
```
    Adds a contenttype to the element.
    
    Parameters:
    
    mediaContentType - to be added
  - removeContentType
```
void removeContentType(MediaContentType mediaContentType)
```
    Removes a contenttype from the element.
    
    Parameters:
    
    mediaContentType - to be removed
  - getFallbackLanguage
```
String getFallbackLanguage()
```
    Returns the fallback language option selected for the element. Possible return values are: a language code ("english" or "dutch", etc), "ignore_fallback_language" or "default". "default" will be returned in case of null or an empty String.
    
    Returns:
    
    fallback language option.
  - setFallbackLanguage
```
void setFallbackLanguage(String language)
```
    Sets the fallback language for the element. possible values:
    
    "ignore_fallback_language": ignore the General Fallback language setting.
    
    "default": use the General Fallback language setting.
    
    languagecode ("english", "dutch", etc): use this language as the Fallback language.
    
    null or an empty String as value will remove the fallback language, basically the same as "default"
    Parameters:
    
    language -
  - isContentDependent
```
boolean isContentDependent()
```
    Returns if the mediaitems should be content dependent.
    
    Returns:
    
    indication if content dependent
  - setContentDependent
```
void setContentDependent(boolean isContentDependent)
```
    Sets if the mediaitems should be content dependent.
    
    Parameters:
    
    isContentDependent - if content dependent
  - getContentDependentOperator
```
String getContentDependentOperator()
```
    Deprecated.
    Use getContentRelatedOperator instead, which returns a the operator as an enum value instead of a String
    
    Returns the OR or AND operator for the "Content related" pulldown, either "OR" or "AND"
    
    Returns:
    
    "OR" or "AND" operator
  - getContentRelatedOperator
```
ContentRelatedOperator getContentRelatedOperator()
```
    Returns the content related operator to use in this overview. See ContentRelatedOperator for more information about the content related operator.
    
    Returns:
    
    the content related operator to use in this overview
  - setContentRelatedOperator
```
void setContentRelatedOperator(ContentRelatedOperator operator)
```
    Sets the content related operator to use in this overview. See ContentRelatedOperator for more information about the content related operator.
    
    Parameters:
    
    operator - the content related operator to use in this overview
  - isTypeOfPageDependent
```
boolean isTypeOfPageDependent()
```
    Returns if the mediaitems should be type of page dependent.
    
    Returns:
    
    indication if type of page dependent
  - setTypeOfPageDependent
```
void setTypeOfPageDependent(boolean isTypeOfPageDependent)
```
    Sets if the mediaitems should be type of page dependent.
    
    Parameters:
    
    isTypeOfPageDependent - indication if type of page dependent
  - getLastNumberOfDays
```
int getLastNumberOfDays()
```
    Returns how many days content may be
    
    Returns:
    
    number of days
  - setLastNumberOfDays
```
void setLastNumberOfDays(int lastNumberOfDays)
```
    Sets how many days content may be shown.
    
    Parameters:
    
    lastNumberOfDays - number of days
  - getMaximumNumberOfItems
```
int getMaximumNumberOfItems()
```
    Returns how many items maximum need to be shown.
    
    Returns:
    
    number of itens
  - setMaximumNumberOfItems
```
void setMaximumNumberOfItems(int maximumNumberOfItems)
```
    Sets how many items maximum need to be shown.
    
    Parameters:
    
    maximumNumberOfItems - number of itens
  - getFromDate
```
Date getFromDate()
```
    Returns the from date for selecting mediaitems
    
    Returns:
    
    from date for selecting mediaitems
  - setFromDate
```
void setFromDate(Date date)
```
    Sets the from date for selecting mediaitems.
    
    Parameters:
    
    date - from date for selecting mediaitems
  - getToDate
```
Date getToDate()
```
    Returns the to date for selecting mediaitems.
    
    Returns:
    
    to date for selecting mediaitems
  - setToDate
```
void setToDate(Date date)
```
    Sets the to date for selecting mediaitems.
    
    Parameters:
    
    date - to date for selecting mediaitems
  - getSortOptions
```
MediaItemSortOptions getSortOptions()
```
    Returns the selected MediaCollectionElementSortOptions.
    
    Returns:
    
    the selected MediaCollectionElementSortOptions
  - setSortOptions
```
void setSortOptions(MediaItemSortOptions mediaItemSortOptions)
```
    Sets the selected MediaItemSortOptions.
    
    Parameters:
    
    mediaItemSortOptions - the selected MediaItemSortOptions
  - isUseLastXDays
```
boolean isUseLastXDays()
```
    Returns if the lastXDays should be used as base for narrowing selection
    
    Returns:
    
    indication if lastXDays is used
  - setUseLastXDays
```
void setUseLastXDays(boolean useLastXDays)
```
    Sets if the lastXDays should be used as base for narrowing selection.
    
    Parameters:
    
    useLastXDays - indication if lastXDays is used
  - isUseDateFromTo
```
boolean isUseDateFromTo()
```
    Returns if the useDateFromTo should be used as base for narrowing selection
    
    Returns:
    
    indication if useDateFromTo is used
  - setUseDateFromTo
```
void setUseDateFromTo(boolean useDateFromTo)
```
    Sets if the dateFromTo should be used as base for narrowing selection.
    
    Parameters:
    
    useDateFromTo - indication if dateFromTo is used
  - isUseTermRelations
```
boolean isUseTermRelations()
```
    Returns if term relations via the thesaurus should be used to find mediaitems
    
    Returns:
    
    indication if term relations should be used
  - setUseTermRelations
```
void setUseTermRelations(boolean useTermRelations)
```
    Sets if term relations via the thesaurus should be used to find mediaitems.
    
    Parameters:
    
    useTermRelations - indication if term relations should be used
  - getShowResultsFrom
```
int getShowResultsFrom()
```
    Returns the value of the 'show results from' field of the Media Overview.
    
    Returns:
    
    int holding the value of the 'show results from' field or -1 if the field is left empty.
  - setShowResultsFrom
```
void setShowResultsFrom(int showResultsFrom)
```
    Sets the value of the 'show results from' field of the Media Overview.
    
    Parameters:
    
    showResultsFrom - holding the value of the 'show results from' field
  - getShowResultsTo
```
int getShowResultsTo()
```
    Returns the value of the 'show results to' field of the Media Overview.
    
    Returns:
    
    int holding the value of the 'show results to' field or -1 if the field is left empty.
  - setShowResultsTo
```
void setShowResultsTo(int showResultsTo)
```
    Sets the value of the 'show results to' field of the Media Overview.
    
    Parameters:
    
    showResultsTo - holding the value of the 'show results to' field

Modifier and Type	Field	Description
`static String`	`DEFAULT_FALLBACK_STRATEGY`
`static String`	`FALLBACK_LANGUAGE`
`static String`	`IGNORE_FALLBACK_LANGUAGE`

Interface MediaCollectionOverviewElement

Nested Class Summary

Nested classes/interfaces inherited from interface nl.gx.webmanager.cms.mediarepository.MediaCollectionElement

Field Summary

Method Summary

Methods inherited from interface nl.gx.webmanager.springmvc.DelegatedControllerAware

Methods inherited from interface nl.gx.webmanager.cms.element.Element

Methods inherited from interface nl.gx.webmanager.cms.mediarepository.MediaCollectionElement

Methods inherited from interface nl.gx.webmanager.cms.core.Presentable

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

Field Detail

DEFAULT_FALLBACK_STRATEGY

FALLBACK_LANGUAGE

IGNORE_FALLBACK_LANGUAGE

Method Detail

getExcludingTerms

addExcludingTerm

removeExcludingTerm

getIncludingTerms

getMandatoryTerms

addMandatoryTerm

removeMandatoryTerm

getOptionalTerms

addOptionalTerm

removeOptionalTerm

getContentTypes

addContentType

removeContentType

getFallbackLanguage

setFallbackLanguage

isContentDependent

setContentDependent

getContentDependentOperator

getContentRelatedOperator

setContentRelatedOperator

isTypeOfPageDependent

setTypeOfPageDependent

getLastNumberOfDays

setLastNumberOfDays

getMaximumNumberOfItems

setMaximumNumberOfItems

getFromDate

setFromDate

getToDate

setToDate

getSortOptions

setSortOptions

isUseLastXDays

setUseLastXDays

isUseDateFromTo

setUseDateFromTo

isUseTermRelations

setUseTermRelations

getShowResultsFrom

setShowResultsFrom

getShowResultsTo

setShowResultsTo