Package org.opencastproject.message.broker.api.series

Class SeriesItem

java.lang.Object

org.opencastproject.message.broker.api.series.SeriesItem

All Implemented Interfaces:

Serializable, MessageItem

public final class SeriesItem
extends Object
implements MessageItem, Serializable

Serializable class that represents all of the possible messages sent through a SeriesService queue.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SeriesItem.Type

Method Summary

Modifier and Type	Method	Description
static SeriesItem	delete(String seriesId)
AccessControlList	getAcl()
String	getElement()
String	getElementType()
DublinCoreCatalog	getExtendedMetadata()
String	getId()
DublinCoreCatalog	getMetadata()
Boolean	getOverrideEpisodeAcl()
String	getPropertyName()
String	getPropertyValue()
String	getSeriesId()
SeriesItem.Type	getType()
static SeriesItem	updateAcl(String seriesId, AccessControlList acl, boolean overrideEpisodeAcl)
static SeriesItem	updateCatalog(DublinCoreCatalog series)
static SeriesItem	updateElement(String seriesId, String type, String data)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

updateCatalog

public static SeriesItem updateCatalog(DublinCoreCatalog series)

Parameters:

series - The series to update.

Returns:

Builds SeriesItem for updating a series.

updateElement

public static SeriesItem updateElement(String seriesId,
 String type,
 String data)

Parameters:

seriesId - The unique id for the series to update.

type - The type of series element.

data - The series element data.

Returns:

Builds SeriesItem for updating series element.

updateAcl

public static SeriesItem updateAcl(String seriesId,
 AccessControlList acl,
 boolean overrideEpisodeAcl)

Parameters:

seriesId - The unique id for the series to update.

acl - The new access control list to update to.

overrideEpisodeAcl - Whether to override the episode ACL.

Returns:

Builds SeriesItem for updating the access control list of a series.

delete

public static SeriesItem delete(String seriesId)

Parameters:

seriesId - The unique id of the series to delete.

Returns:

Builds SeriesItem for deleting a series.

getId

public String getId()

Specified by:

getId in interface MessageItem

getType

public SeriesItem.Type getType()

getSeriesId

public String getSeriesId()

getMetadata

public DublinCoreCatalog getMetadata()

getExtendedMetadata

public DublinCoreCatalog getExtendedMetadata()

getAcl

public AccessControlList getAcl()

getPropertyName

public String getPropertyName()

getPropertyValue

public String getPropertyValue()

getElement

public String getElement()

getElementType

public String getElementType()

getOverrideEpisodeAcl

public Boolean getOverrideEpisodeAcl()