com.jivesoftware.community.media.video
Interface VideoDAO

public interface VideoDAO

DAO for video CRUD

Method Summary

void	delete(Video video) Deletes the given video
void	deleteAllContainerVideos(long containerID, int containerType) Deletes all videos in the container with the given container id and of the given container type
void	deleteAllUserVideos(long userID) Deletes all videos created by the user with the given user id
Video	getVideoByExternalID(String externalID) Retrieves a video using the externalID of the video at the external video service provider (VideoProvider)
Video	getVideoByID(long id) Returns the video with the matching object id
int	getVideoCount(TagSet tagSet) Returns the count of all videos within the given tag set
int	getVideoCount(VideoResultFilter resultFilter) Returns the count of all videos matching the given result filter
JiveIterator<Video>	getVideos(TagSet tagSet, VideoResultFilter videoResultFilter) Returns all videos matching the given result filter in the given tag set
JiveIterator<Video>	getVideos(VideoResultFilter videoResultFilter) Returns all videos matching the given result filter
Video	insert(Video video) Persists the given video and all associated metadata
void	move(Video video, JiveContainer target) Moves a video from its current location to the given target location
void	update(Video video) Updates the video with an id that matches the id in the given video instance with the values encapsulated in the video instance

Method Detail

delete

void delete(Video video)
            throws DAOException

Deletes the given video

Parameters:

video - to delete

Throws:

DAOException

update

void update(Video video)
            throws DAOException

Updates the video with an id that matches the id in the given video instance with the values encapsulated in the video instance

Parameters:

video - to update

Throws:

DAOException

insert

Video insert(Video video)
             throws DAOException

Persists the given video and all associated metadata

Parameters:

video - to insert

Returns:

the inserted video

Throws:

DAOException

getVideoByExternalID

Video getVideoByExternalID(String externalID)
                           throws DAOException

Retrieves a video using the externalID of the video at the external video service provider (VideoProvider)

Parameters:

externalID - of a video that exists in the system and at the external service provider

Returns:

the video in the system with the matching externalID *

Throws:

DAOException

getVideoByID

Video getVideoByID(long id)
                   throws DAOException

Returns the video with the matching object id

Parameters:

id - of the video to retrieve

Returns:

the video with the matching id

Throws:

DAOException

getVideos

JiveIterator<Video> getVideos(VideoResultFilter videoResultFilter)

Returns all videos matching the given result filter

Parameters:

videoResultFilter - used to constrain the query

Returns:

a JiveIterator of all matching videos

getVideos

JiveIterator<Video> getVideos(TagSet tagSet,
                              VideoResultFilter videoResultFilter)

Returns all videos matching the given result filter in the given tag set

Parameters:

tagSet - used to constrain the query

videoResultFilter - used to constrain the query

Returns:

a JiveIterator of all matching videos

getVideoCount

int getVideoCount(TagSet tagSet)

Returns the count of all videos within the given tag set

Parameters:

tagSet - used to constrain the query

Returns:

count of all videos in the tag set

getVideoCount

int getVideoCount(VideoResultFilter resultFilter)

Returns the count of all videos matching the given result filter

Parameters:

resultFilter - used to constrain the query

Returns:

the count of all matching videos

deleteAllUserVideos

void deleteAllUserVideos(long userID)

Deletes all videos created by the user with the given user id

Parameters:

userID - of the user whose videos will be deleted

deleteAllContainerVideos

void deleteAllContainerVideos(long containerID,
                              int containerType)

Deletes all videos in the container with the given container id and of the given container type

Parameters:

containerID - of the container whose videos will be deleted

containerType - the type of container

move

void move(Video video,
          JiveContainer target)

Moves a video from its current location to the given target location

Parameters:

video - to be moved

target - destination container