Package org.opencastproject.search.api

Interface SearchService

All Known Implementing Classes:

SearchServiceImpl

public interface SearchService

Provides search capabilities, possibly to the engage tools, possibly to other services.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SearchService.IndexEntryType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_TYPE	Identifier for service registration and location

Method Summary

Modifier and Type	Method	Description
Job	add(MediaPackage mediaPackage)	Adds the media package to the search index.
void	addSynchronously(MediaPackage mediaPackage)	Immediately adds the mediapackage to the search index.
Job	delete(String mediaPackageId)	Removes the media package identified by mediaPackageId from the search index.
Job	deleteSeries(String seriesId)	Removes the series identified by seriseId from the search index.
boolean	deleteSynchronously(String mediaPackageId)	Immediately removes the given mediapackage from the search service.
MediaPackage	get(String mediaPackageId)	Gets the MediaPackage for an event, based on its mediapackage ID.
Collection<org.apache.commons.lang3.tuple.Pair<Organization,MediaPackage>>	getSeries(String seriesId)	Returns a list of Organization,MediaPackage pairs of mediapackages within a series.
SearchResultList	search(org.elasticsearch.search.builder.SearchSourceBuilder searchSource)	Searches the index based on a SearchSourceBuilder's query

Field Details

JOB_TYPE

static final String JOB_TYPE

Identifier for service registration and location

See Also:

• Constant Field Values

Method Details

add

Job add(MediaPackage mediaPackage)
 throws SearchException,
MediaPackageException,
UnauthorizedException,
ServiceRegistryException

Adds the media package to the search index.

Parameters:

mediaPackage - the media package

Throws:

SearchException - if an error occurs while adding the media package

MediaPackageException - if an error occurs accessing the media package

UnauthorizedException - if the current user is not authorized to add this media package to the search index

ServiceRegistryException - if the job for adding the mediapackage can not be created

getSeries

Collection<org.apache.commons.lang3.tuple.Pair<Organization,MediaPackage>> getSeries(String seriesId)

Returns a list of Organization,MediaPackage pairs of mediapackages within a series. Note that the Organization should always be the same since series should not cross organizational bounds.

Parameters:

seriesId - the series ID to query

Returns:

A list of Organization,MediaPackage pairs of mediapackages within the series.

addSynchronously

void addSynchronously(MediaPackage mediaPackage)
               throws SearchException,
IllegalArgumentException,
UnauthorizedException

Immediately adds the mediapackage to the search index.

Parameters:

mediaPackage - the media package

Throws:

SearchException - if the media package cannot be added to the search index

IllegalArgumentException - if the mediapackage is null

UnauthorizedException - if the user does not have the rights to add the mediapackage

delete

Job delete(String mediaPackageId)
    throws SearchException,
UnauthorizedException,
NotFoundException

Removes the media package identified by mediaPackageId from the search index.

Parameters:

mediaPackageId - id of the media package to remove

Returns:

true if the episode was found and deleted

Throws:

SearchException - if an error occurs while removing the media package

UnauthorizedException - if the current user is not authorized to remove this mediapackage from the search index

NotFoundException

deleteSeries

Job deleteSeries(String seriesId)
          throws SearchException,
UnauthorizedException,
NotFoundException

Removes the series identified by seriseId from the search index. Does *not* remove the associated events from the index!

Parameters:

seriesId - id of the series to remove

Returns:

true if the series was found and deleted

Throws:

SearchException - if an error occurs while removing the series

UnauthorizedException - if the current user is not authorized to remove this series from the search index

NotFoundException

deleteSynchronously

boolean deleteSynchronously(String mediaPackageId)
                     throws SearchException

Immediately removes the given mediapackage from the search service.

Parameters:

mediaPackageId - the mediapackage

Returns:

true if the mediapackage was deleted

Throws:

SearchException - if deletion failed

get

MediaPackage get(String mediaPackageId)
          throws NotFoundException,
SearchException,
UnauthorizedException

Gets the MediaPackage for an event, based on its mediapackage ID.

Parameters:

mediaPackageId - The ID of the mediapackage in question

Returns:

The MediaPackage

Throws:

NotFoundException - If the mediapackage is not found.

SearchException - If an error occurs while searching for the mediapackage.

UnauthorizedException - if the current user is not authorized to view this mediapackage.

search

SearchResultList search(org.elasticsearch.search.builder.SearchSourceBuilder searchSource)
                 throws SearchException

Searches the index based on a SearchSourceBuilder's query

Parameters:

searchSource - The SearchSourceBuilder defining the search query

Returns:

A SearchResultList of the search's results

Throws:

SearchException - If an error occurs while searching the index.