com.jivesoftware.community.media.video
Class VideoResultFilter

java.lang.Object
  com.jivesoftware.community.ResultFilter
      com.jivesoftware.community.media.MediaResultFilter<Class<? extends Video>>
          com.jivesoftware.community.media.video.VideoResultFilter

public class VideoResultFilter
extends MediaResultFilter<Class<? extends Video>>

Base result filter for multimedia content

Nested Class Summary

static class

VideoResultFilter.SortField

Field Summary

static int	SORT_FAVORITES
static int	SORT_LENGTH
static int	SORT_RATINGS
static int	SORT_VIEWS

Fields inherited from class com.jivesoftware.community.ResultFilter

AND_MODE, ASCENDING, CONTAINS_MATCH, DESCENDING, EXACT_MATCH, NULL_INT, OR_MODE

Constructor Summary

VideoResultFilter()

Method Summary

static VideoResultFilter	createDefaultContainerFilter(JiveContainer container)
static VideoResultFilter	createDefaultFilter() Returns a default result filter that restricts results to published, non-embedded videos sorted by modification date in descending order
static VideoResultFilter	createDefaultUserFilter(User user) Returns a default result filter that restricts results to published, non-embedded videos created by the given user sorted by modification date in descending order
Integer	getDuration()
Boolean	getEmbedded()
String	getExternalID()
VideoResultFilter	getNonTemplateFilter()
void	setDuration(Integer duration)
void	setEmbedded(Boolean embedded)
void	setExternalID(String externalID)
void	setSort(VideoResultFilter.SortField sort, int order)

Methods inherited from class com.jivesoftware.community.media.MediaResultFilter

getContainerID, getContainerType, getFilteredMediaType, getID, getStatus, setContainer, setContainerID, setContainerType, setID, setStatus

Methods inherited from class com.jivesoftware.community.ResultFilter

addProperty, addProperty, addTag, createDefaultContentFilter, createDefaultRecursiveContentFilter, equals, getCreationDateRangeMax, getCreationDateRangeMin, getModificationDateRangeMax, getModificationDateRangeMin, getNumResults, getPropertyCount, getPropertyMatchType, getPropertyMode, getPropertyName, getPropertyValue, getPropertyValueString, getSortField, getSortOrder, getSortPropertyName, getStartIndex, getTags, getUserID, hashCode, isAllTagsRequired, isPerformDistinctCount, isRecursive, setAllTagsRequired, setCreationDateRangeMax, setCreationDateRangeMin, setModificationDateRangeMax, setModificationDateRangeMin, setNumResults, setPerformDistinctCount, setPropertyMode, setRecursive, setSortField, setSortOrder, setSortPropertyName, setStartIndex, setTags, setUserID, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SORT_RATINGS

public static final int SORT_RATINGS

See Also:

Constant Field Values

SORT_VIEWS

public static final int SORT_VIEWS

See Also:

Constant Field Values

SORT_FAVORITES

public static final int SORT_FAVORITES

See Also:

Constant Field Values

SORT_LENGTH

public static final int SORT_LENGTH

See Also:

Constant Field Values

Constructor Detail

VideoResultFilter

public VideoResultFilter()

Method Detail

createDefaultFilter

public static VideoResultFilter createDefaultFilter()

Returns a default result filter that restricts results to published, non-embedded videos sorted by modification date in descending order

Returns:

the result filter

createDefaultUserFilter

public static VideoResultFilter createDefaultUserFilter(User user)

Returns a default result filter that restricts results to published, non-embedded videos created by the given user sorted by modification date in descending order

Parameters:

user - whose videos should be returned by a query using the filter

Returns:

the result filter

createDefaultContainerFilter

public static VideoResultFilter createDefaultContainerFilter(JiveContainer container)

getEmbedded

public Boolean getEmbedded()

setEmbedded

public void setEmbedded(Boolean embedded)

setExternalID

public void setExternalID(String externalID)

getExternalID

public String getExternalID()

getDuration

public Integer getDuration()

setDuration

public void setDuration(Integer duration)

getNonTemplateFilter

public VideoResultFilter getNonTemplateFilter()

Overrides:

getNonTemplateFilter in class MediaResultFilter<Class<? extends Video>>

setSort

public void setSort(VideoResultFilter.SortField sort,
                    int order)