Interface MediaItemFilter


  • public interface MediaItemFilter
    Represents the media item filter. Filter can be used for searching media items.
    • Method Detail

      • getTitle

        String getTitle()
        Returns the title.
        Returns:
        the title
      • setTitle

        void setTitle​(String webtitle)
        Sets the filter title. This may include the following wildcards:
        • '_' A substitute for exactly one character.
        • '%' A substitute for zero or more characters.
        Parameters:
        type - the title to set
      • getContentType

        MediaContentType[] getContentType()
        Returns the filter content type.
        Returns:
        the content type
      • setContentType

        void setContentType​(MediaContentType[] type)
        Sets the filter content type.
        Parameters:
        type - the content type to set
      • getFallbackLanguage

        Language getFallbackLanguage()
        Returns the chosen fallback language.
        Returns:
        the fallback language object
      • setFallbackLanguage

        void setFallbackLanguage​(Language language)
        Sets the filter fallback language.
        Parameters:
        language - the fallback language object
      • setFallbackLanguageStrategy

        void setFallbackLanguageStrategy​(MediaItemFilter.FallbackLanguageStrategy languageStrategy)
        Sets the filter fallback language strategy.
        Parameters:
        languageStrategy - the fallback language strategy
      • getTerms

        MediaTerm[] getTerms​(MediaItemFilter.OperationType type)
        Returns the filter media terms for the given operation type.
        Parameters:
        type - the operation type
        Returns:
        the media terms
      • setTerms

        void setTerms​(MediaTerm[] terms,
                      MediaItemFilter.OperationType type)
        Sets the filter terms for the given operation type.
        Parameters:
        terms - the media item terms to set
        type - the operation type
      • getPublicationDateFrom

        Date getPublicationDateFrom()
        Returns the filter publication date from parameter.
        Returns:
        the publication date from parameter
      • setPublicationDateFrom

        void setPublicationDateFrom​(Date fromDate)
        Sets the filter publication date from parameter.
        Parameters:
        fromDate - the publication date from parameter to set
      • getPublicationDateTo

        Date getPublicationDateTo()
        Returns the filter publication date to parameter.
        Returns:
        the publication date to parameter
      • setPublicationDateTo

        void setPublicationDateTo​(Date toDate)
        Sets the filter publication date to parameter.
        Parameters:
        toDate - the publication date to parameter to set
      • getCreatedSince

        int getCreatedSince()
        Returns the filter created since days parameter.
        Returns:
        the created since parameter
      • setCreatedSince

        void setCreatedSince​(int days)
        Sets the filter created since days parameter.
        Parameters:
        days - the created since parameter to set
      • getResultFrom

        int getResultFrom()
        Returns the filter from range parameter.
        Returns:
        the from range
      • getResultTo

        int getResultTo()
        Returns the filter to range parameter.
        Returns:
        the to range
      • setResultRange

        void setResultRange​(int from,
                            int to)
        Sets the filter result range parameter.
        Parameters:
        from - the from range to set
        to - the to range to set
      • setStatus

        void setStatus​(WorkflowModelState[] states)
        Sets the filter state.
        Parameters:
        states - the states to set
      • getExcludeMediaItems

        MediaItem[] getExcludeMediaItems()
        Returns the filter exclude media items parameter.
        Returns:
        the exclude media items
      • setExcludeMediaItems

        void setExcludeMediaItems​(MediaItem[] mediaItems)
        Set the filter exclude media items parameter.
        Parameters:
        mediaItems - the exclude media items to set
      • setReferencedResourceInstance

        void setReferencedResourceInstance​(ResourceInstance resourceInstance)
        Set the referenced database resource instance
        Parameters:
        resourceInstance - the referenced resource instance to set
      • getReferencedResourceInstance

        ResourceInstance getReferencedResourceInstance()
        Returns the filter referenced database resource instance
        Returns:
        the referenced resource instance
      • getReferencedMediaItem

        MediaItem getReferencedMediaItem()
        Returns the filter referenced media item.
        Returns:
        the referenced media item.
      • setReferencedMediaItem

        void setReferencedMediaItem​(MediaItem mediaItem)
        Sets the filter referenced media item.
        Parameters:
        dbid - the referenced media item.
      • setReferencedMediaItemOperator

        void setReferencedMediaItemOperator​(String operator)
        Sets the context dependent operator
        Parameters:
        operator -
      • getReferencedMediaItemOperator

        String getReferencedMediaItemOperator()
        Returns the context dependent operator
        Returns:
        operator OR/AND
      • getExternalId

        String getExternalId()
        Returns the filter external id parameter. The externalId could have been set during the creation of a mediaItem in ways other than via the regular edit interface.
        Returns:
        the external id parameter
      • setExternalId

        void setExternalId​(String externalId)
        Sets the filter external id parameter. The externalId can be set during the creation of a mediaItem in ways other than via the regular edit interface in order to be able to retrieve this mediaItem based on that same externalId
        Parameters:
        externalId - the external id parameter to set
      • setExpirationDateFrom

        void setExpirationDateFrom​(Date fromDate)
        Sets the filter expiration fromdate from parameter.
        Parameters:
        expiration - fromDate
      • getExpirationDateFrom

        Date getExpirationDateFrom()
        Returns the filter expiration date to parameter.
        Returns:
        the expiration fromDate
      • setExpirationDateTo

        void setExpirationDateTo​(Date toDate)
        Sets the filter expiration todate from parameter.
        Parameters:
        expiration - toDate
      • getExpirationDateTo

        Date getExpirationDateTo()
        Returns the filter expiration date to parameter.
        Returns:
        the expiration toDate
      • setMediaTermPolicy

        void setMediaTermPolicy​(MediaItemFilter.MediaTermPolicy policy)
        Set the Policy to use for retrieving terms.
        Parameters:
        policy - find MediaItems tagged with terms matching the specified policy.
      • getMediaTermPolicy

        MediaItemFilter.MediaTermPolicy getMediaTermPolicy()
        Get the Policy to use for retrieving terms.
        Returns:
        the MediaTermPolicy. The default: SPECIFIED_OR_NARROWER_TERMS.
      • getLanguage

        Language getLanguage()
        Get the frontend language to use for retrieving terms.
        Returns:
        the Language or null.
      • setLanguage

        void setLanguage​(Language language)
        Set the frontend language to use for retrieving terms.
        Parameters:
        language - find MediaItems having a version with this language.