org.opencastproject.metadata.dublincore

Interface SeriesCatalogUIAdapter

public interface SeriesCatalogUIAdapter

A SeriesCatalogUIAdapter converts between a concrete MetadataCatalog implementation and a MetadataCollection that

Method Summary

Modifier and Type	Method and Description
com.entwinemedia.fn.data.Opt<MetadataCollection>	getFields(String seriesId) Returns all fields of this catalog containing the data in an abstract, editable form.
String	getFlavor() Returns the media type of catalogs managed by this catalog UI adapter.
String	getOrganization() Returns the name of the organization (tenant) this catalog UI adapter belongs to or Opt.none() if this is a tenant-agnostic adapter.
MetadataCollection	getRawFields() Returns all fields of this catalog in a raw data format.
String	getUITitle()
boolean	storeFields(String seriesId, MetadataCollection metadata) Store changes made to the fields of the metadata collection in the catalog and return an updated version of it.

Method Detail

getOrganization

String getOrganization()

Returns the name of the organization (tenant) this catalog UI adapter belongs to or Opt.none() if this is a tenant-agnostic adapter.

Returns:

The organization name or Opt.none()

getFlavor

String getFlavor()

Returns the media type of catalogs managed by this catalog UI adapter.

Returns:

The media type of the catalog

getUITitle

String getUITitle()

Returns:

Get the human readable title for this catalog ui adapter for various languages.

getRawFields

MetadataCollection getRawFields()

Returns all fields of this catalog in a raw data format. This is a good starting point to create a new instance of this catalog.

Returns:

The fields with raw data

getFields

com.entwinemedia.fn.data.Opt<MetadataCollection> getFields(String seriesId)

Returns all fields of this catalog containing the data in an abstract, editable form. If the series cannot be found, Opt.none() is returned.

Parameters:

seriesId - The series identifer

Returns:

Get the field names and values for this catalog.

storeFields

boolean storeFields(String seriesId,
                    MetadataCollection metadata)

Store changes made to the fields of the metadata collection in the catalog and return an updated version of it.

Parameters:

seriesId - The series identifier

metadata - The new metadata to update the mediapackage with

Returns:

true, if the metadata could be saved successfully