Package io.goobi.viewer.model.cms

Class CMSArchiveConfig

java.lang.Object

io.goobi.viewer.model.cms.CMSArchiveConfig

All Implemented Interfaces:

CMSMediaHolder, CMSMediaMultiHolder, Serializable

@Entity
public class CMSArchiveConfig
extends Object
implements CMSMediaMultiHolder, Serializable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CMSArchiveConfig()
CMSArchiveConfig(CMSArchiveConfig orig)	Cloning constructor.
CMSArchiveConfig(String pi)

Method Summary

Modifier and Type	Method	Description
LocalDateTime	getDateUpdated()
TranslatedText	getDescription()
CMSMediaItem	getHeaderImage()
Long	getId()
String	getMediaFilter()	A regular expression determining which filenames are shown in the media list and may be uploaded
String	getMediaFilter(int index)	A regular expression determining which filenames are shown in the media list and may be uploaded
CMSMediaItem	getMediaItem()	getMediaItem.
CMSMediaItem	getMediaItem(int index)	getMediaItem.
CategorizableTranslatedSelectable<CMSMediaItem>	getMediaItemWrapper()	getMediaItemWrapper.
CategorizableTranslatedSelectable<CMSMediaItem>	getMediaItemWrapper(int index)	getMediaItemWrapper.
String	getMediaTypes()	A string representing the allowed media formates for a user.
String	getMediaTypes(int index)	A string representing the allowed media formats for a user.
String	getPi()
TranslatedText	getPreviewText()
String	getShortDescription(int maxLength)
CMSMediaItem	getTileImage()
TranslatedText	getTitle()
boolean	hasMediaItem()	hasMediaItem.
boolean	hasMediaItem(int index)	hasMediaItem.
void	setDateUpdated(LocalDateTime dateUpdated)
void	setDescription(TranslatedText description)
void	setHeaderImage(CMSMediaItem headerImage)
void	setId(Long id)
void	setMediaItem(int index, CMSMediaItem item)	setMediaItem.
void	setMediaItem(CMSMediaItem item)	setMediaItem.
void	setPi(String pi)
void	setPreviewText(TranslatedText previewText)
void	setTileImage(CMSMediaItem tileImage)
void	setTitle(TranslatedText title)

Methods inherited from class java.lang.Object

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

Constructor Details

CMSArchiveConfig

public CMSArchiveConfig()

CMSArchiveConfig

public CMSArchiveConfig(String pi)

Parameters:

pi -

CMSArchiveConfig

public CMSArchiveConfig(CMSArchiveConfig orig)

Cloning constructor. Must be updated after any changes to the class.

Parameters:

orig - CMSArchiveConfig to clone

Method Details

getId

public Long getId()

Returns:

the id

setId

public void setId(Long id)

Parameters:

id - the id to set

getPi

public String getPi()

Returns:

the pi

setPi

public void setPi(String pi)

Parameters:

pi - the pi to set

getDateUpdated

public LocalDateTime getDateUpdated()

Returns:

the dateUpdated

setDateUpdated

public void setDateUpdated(LocalDateTime dateUpdated)

Parameters:

dateUpdated - the dateUpdated to set

getTitle

public TranslatedText getTitle()

Returns:

the title

setTitle

public void setTitle(TranslatedText title)

Parameters:

title - the title to set

getPreviewText

public TranslatedText getPreviewText()

Returns:

the previewText

setPreviewText

public void setPreviewText(TranslatedText previewText)

Parameters:

previewText - the previewText to set

getDescription

public TranslatedText getDescription()

Returns:

the description

setDescription

public void setDescription(TranslatedText description)

Parameters:

description - the description to set

getTileImage

public CMSMediaItem getTileImage()

Returns:

the tileImage

setTileImage

public void setTileImage(CMSMediaItem tileImage)

Parameters:

tileImage - the tileImage to set

getHeaderImage

public CMSMediaItem getHeaderImage()

Returns:

the headerImage

setHeaderImage

public void setHeaderImage(CMSMediaItem headerImage)

Parameters:

headerImage - the headerImage to set

getShortDescription

public String getShortDescription(int maxLength)

Parameters:

maxLength - maximum character length

Returns:

truncated plaintext

setMediaItem

public void setMediaItem(CMSMediaItem item)

Description copied from interface: CMSMediaHolder

setMediaItem.

Specified by:

setMediaItem in interface CMSMediaHolder

Parameters:

item - a CMSMediaItem object.

getMediaItem

public CMSMediaItem getMediaItem()

Description copied from interface: CMSMediaHolder

getMediaItem.

Specified by:

getMediaItem in interface CMSMediaHolder

Returns:

a CMSMediaItem object.

getMediaFilter

public String getMediaFilter()

Description copied from interface: CMSMediaHolder

A regular expression determining which filenames are shown in the media list and may be uploaded

Specified by:

getMediaFilter in interface CMSMediaHolder

Returns:

a String object.

getMediaTypes

public String getMediaTypes()

Description copied from interface: CMSMediaHolder

A string representing the allowed media formates for a user. Should be a comma separated list of format names or filename suffixes

Specified by:

getMediaTypes in interface CMSMediaHolder

Returns:

String

hasMediaItem

public boolean hasMediaItem()

Description copied from interface: CMSMediaHolder

hasMediaItem.

Specified by:

hasMediaItem in interface CMSMediaHolder

Returns:

a boolean.

getMediaItemWrapper

public CategorizableTranslatedSelectable<CMSMediaItem> getMediaItemWrapper()

Description copied from interface: CMSMediaHolder

getMediaItemWrapper.

Specified by:

getMediaItemWrapper in interface CMSMediaHolder

Returns:

a CategorizableTranslatedSelectable object.

setMediaItem

public void setMediaItem(int index,
 CMSMediaItem item)

Description copied from interface: CMSMediaMultiHolder

setMediaItem.

Specified by:

setMediaItem in interface CMSMediaMultiHolder

Parameters:

index - Index of the media item

item - a CMSMediaItem object.

getMediaItem

public CMSMediaItem getMediaItem(int index)

Description copied from interface: CMSMediaMultiHolder

getMediaItem.

Specified by:

getMediaItem in interface CMSMediaMultiHolder

Parameters:

index - Index of the media item

Returns:

a CMSMediaItem object.

getMediaFilter

public String getMediaFilter(int index)

Description copied from interface: CMSMediaMultiHolder

A regular expression determining which filenames are shown in the media list and may be uploaded

Specified by:

getMediaFilter in interface CMSMediaMultiHolder

Parameters:

index - Index of the media item

Returns:

a String object.

getMediaTypes

public String getMediaTypes(int index)

Description copied from interface: CMSMediaMultiHolder

A string representing the allowed media formats for a user. Should be a comma separated list of format names or filename suffixes

Specified by:

getMediaTypes in interface CMSMediaMultiHolder

Parameters:

index - Index of the media item

Returns:

String

hasMediaItem

public boolean hasMediaItem(int index)

Description copied from interface: CMSMediaMultiHolder

hasMediaItem.

Specified by:

hasMediaItem in interface CMSMediaMultiHolder

Parameters:

index - Index of the media item

Returns:

a boolean.

getMediaItemWrapper

public CategorizableTranslatedSelectable<CMSMediaItem> getMediaItemWrapper(int index)

Description copied from interface: CMSMediaMultiHolder

getMediaItemWrapper.

Specified by:

getMediaItemWrapper in interface CMSMediaMultiHolder

Parameters:

index - Index of the media item

Returns:

a CategorizableTranslatedSelectable object.