Package de.espirit.firstspirit.access.packagepool

Interface ContentPackage

All Superinterfaces:

Comparable<Package>, Lockable, Package

@NonExtendable
public interface ContentPackage
extends Package

The interface ContentPackage represents a package which contains content nodes. Content nodes are StoreElement's from these stores (pagestore, sitestore and mediastore)

Since:

3.1.158

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.packagepool.Package

Package.Type

Field Summary

Fields inherited from interface de.espirit.firstspirit.access.packagepool.Package

CONTENT_PACKAGE, TEMPLATE_PACKAGE, WF_ACTUALIZE, WF_CONFLICT, WF_ERROR, WF_OK, WF_RELEASE

Method Summary

Modifier and Type	Method	Description
void	addSitestoreVariable(String name)	Deprecated. since 5.0.101 - no replacement
Set<String>	getSitestoreVariables()	Deprecated. since 5.0.101 - no replacement
@Nullable TemplatePackage	getTemplatePackage()	Returns the TemplatePackage on which this ContentPackage is dependent or null if no dependent TemplatePackage existing for this ContentPackage.
boolean	isValidNodeType(StoreElement node)	Only accepts nodes from pagestore, sitestore, or mediastore.
void	removeSitestoreVariable(String name)	Deprecated. since 5.0.101 - no replacement
void	setTemplatePackage(TemplatePackage templatePackage)	Sets the given TemplatePackage as the dependent template package for this ContentPackage. Before the import of this ContentPackage the dependent TemplatePackage will be imported.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.access.Lockable

isChanged, isLocked, lock, refresh, save, unlock

Methods inherited from interface de.espirit.firstspirit.access.packagepool.Package

addAuthorisedUser, addPublishUser, addResponsibleUser, addStartNode, containsStartNode, createVersion, createVersion, delete, getAllNameSpaceEnhancements, getAllOverwriteDuringImportSettings, getAuthorisedUsers, getComment, getCustomEventNames, getCustomEventScriptName, getCustomEventScripts, getId, getName, getPackageType, getPublisher, getPublishUsers, getResponsibleUsers, getStartNodes, getStartNodes, getType, getVersion, getVersions, getWorkflowName, isAvailable, isReadOnly, overwriteDuringImport, overwriteDuringImport, publishPackage, publishPackage, removeAuthorisedUser, removeCustomEvent, removePublishUser, removeResponsibleUser, removeStartNode, removeVersion, setAvailable, setComment, setCustomScriptName, setName, setOverwriteDuringImport, setOverwriteDuringImport, setReadOnly, setUseNameSpaceEnhancement, setUseNameSpaceEnhancement, setWorkflow, subscribePackage, subscribePackage, useNameSpaceEnhancement, useNameSpaceEnhancement

Method Details

isValidNodeType

boolean isValidNodeType(StoreElement node)

Only accepts nodes from pagestore, sitestore, or mediastore.

Specified by:

isValidNodeType in interface Package

Returns:

true, if the node is from one of the above stores.

Since:

3.1.158

getSitestoreVariables

@Deprecated
Set<String> getSitestoreVariables()

Deprecated.

since 5.0.101 - no replacement

Always returns an empty set.

Returns:

An empty set.

addSitestoreVariable

@Deprecated
void addSitestoreVariable(String name)

Deprecated.

since 5.0.101 - no replacement

Does nothing.

Parameters:

name - A name.

removeSitestoreVariable

@Deprecated
void removeSitestoreVariable(String name)

Deprecated.

since 5.0.101 - no replacement

Does nothing.

Parameters:

name - A name.

getTemplatePackage

@Nullable
@Nullable TemplatePackage getTemplatePackage()

Returns the TemplatePackage on which this ContentPackage is dependent or null if no dependent TemplatePackage existing for this ContentPackage.

Returns:

TemplatePackage the dependent TemplatePackage.

Since:

3.1.158

setTemplatePackage

void setTemplatePackage(TemplatePackage templatePackage)

Sets the given TemplatePackage as the dependent template package for this ContentPackage.
Before the import of this ContentPackage the dependent TemplatePackage will be imported.

Parameters:

templatePackage - to set as dependent TemplatePackage

Since:

3.1.158