Package org.opencastproject.publication.api

Interface ConfigurablePublicationService

All Known Implementing Classes:

ConfigurablePublicationServiceImpl, ConfigurablePublicationServiceRemoteImpl

public interface ConfigurablePublicationService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_TYPE

Method Summary

Modifier and Type	Method	Description
Job	replace(MediaPackage mediaPackage, String channelId, Collection<? extends MediaPackageElement> addElements, Set<String> retractElementIds)	Replaces media package elements.
Publication	replaceSync(MediaPackage mediaPackage, String channelId, Collection<? extends MediaPackageElement> addElements, Set<String> retractElementIds)	Synchronously replaces media package elements.

Field Details

JOB_TYPE

static final String JOB_TYPE

See Also:

• Constant Field Values

Method Details

replace

Job replace(MediaPackage mediaPackage,
 String channelId,
 Collection<? extends MediaPackageElement> addElements,
 Set<String> retractElementIds)
     throws PublicationException,
MediaPackageException

Replaces media package elements.

Parameters:

mediaPackage - the media package

channelId - the id of the publication channel

addElements - the media package elements to be added

retractElementIds - the ids of the media package elements to be removed

Returns:

The job

Throws:

PublicationException - if there was a problem publishing the media

MediaPackageException - if there was a problem with the mediapackage element

replaceSync

Publication replaceSync(MediaPackage mediaPackage,
 String channelId,
 Collection<? extends MediaPackageElement> addElements,
 Set<String> retractElementIds)
                 throws PublicationException,
MediaPackageException

Synchronously replaces media package elements.

Parameters:

mediaPackage - the media package

channelId - the id of the publication channel

addElements - the media package elements to be added

retractElementIds - the ids of the media package elements to be removed

Returns:

The publication with the updated media package.

Throws:

PublicationException - if there was a problem publishing the media

MediaPackageException - if there was a problem with the mediapackage element