magoffin.matt.ma2.biz
Interface IndexBiz

All Known Implementing Classes:

LuceneBiz

public interface IndexBiz

API for search index indexing methods.

Version:

$Revision: 43 $ $Date: 2007-10-21 11:10:01 +1300 (Sun, 21 Oct 2007) $

Author:

Matt Magoffin (spamsqr@msqr.us)

Method Summary

void	indexMediaItem(java.lang.Long itemId) Index a MediaItem object based on its ID.
void	indexUser(java.lang.Long userId) Index a user object based on its ID.
WorkBiz.WorkInfo	recreateMediaItemIndex(BizContext context) Rebuild the entire MediaItem index.
WorkBiz.WorkInfo	recreateUserIndex(BizContext context) Rebuild the entire user index.
void	removeMediaItemFromIndex(java.lang.Long itemId) Remove a MediaItem from the index.
void	removeUserFromIndex(java.lang.Long userId) Remove a user from the index.

Method Detail

indexUser

void indexUser(java.lang.Long userId)

Index a user object based on its ID.

This method must support indexing a user that may or may not have been indexed before.

Parameters:

userId - the ID of the user to index

removeUserFromIndex

void removeUserFromIndex(java.lang.Long userId)

Remove a user from the index.

Parameters:

userId - the ID of the user to remove

recreateUserIndex

WorkBiz.WorkInfo recreateUserIndex(BizContext context)

Rebuild the entire user index.

Parameters:

context - the current context

Returns:

the work info

indexMediaItem

void indexMediaItem(java.lang.Long itemId)

Index a MediaItem object based on its ID.

This method must support indexing an item that may or may not have been indexed before.

Parameters:

itemId - the ID of the item to index

removeMediaItemFromIndex

void removeMediaItemFromIndex(java.lang.Long itemId)

Remove a MediaItem from the index.

Parameters:

itemId - the ID of the item to remove

recreateMediaItemIndex

WorkBiz.WorkInfo recreateMediaItemIndex(BizContext context)

Rebuild the entire MediaItem index.

Parameters:

context - the current context

Returns:

the work info