Package org.opencms.module

Class CmsModuleImportData

java.lang.Object

org.opencms.module.CmsModuleImportData

public class CmsModuleImportData
extends Object

Module data read from a module zip file.

Constructor Summary

Constructors

Constructor	Description
CmsModuleImportData()

Method Summary

Modifier and Type	Method	Description
void	addResource(CmsResourceImportData resourceData)	Adds the information for a single resource.
boolean	checkUpdatable(CmsObject cms)	Checks if the installed module is updatable with the version from the import zip file.
CmsObject	getCms()	Gets the CMS object.
Map<CmsUUID,CmsUUID>	getConflictingIds()	Gets the map of conflicting ids.
CmsModule	getModule()	Gets the module metadata from the import zip.
List<CmsResourceImportData>	getResourceData()	Gets the list of resource data objects for the manifest entries.
void	setCms(CmsObject cms)	Sets the CMS object.
void	setModule(CmsModule module)	Sets the module metadata.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsModuleImportData

public CmsModuleImportData()

Method Details

addResource

public void addResource(CmsResourceImportData resourceData)

Adds the information for a single resource.

Parameters:

resourceData - the information for a single resource

checkUpdatable

public boolean checkUpdatable(CmsObject cms)

Checks if the installed module is updatable with the version from the import zip file.

Parameters:

cms - the current CMS context

Returns:

true if the module is updatable

getCms

public CmsObject getCms()

Gets the CMS object.

Returns:

the CMS object

getConflictingIds

public Map<CmsUUID,CmsUUID> getConflictingIds()

Gets the map of conflicting ids.

The keys are structure ids from the manifest, the values are structure ids from the VFS.

Returns:

the conflicting id map

getModule

public CmsModule getModule()

Gets the module metadata from the import zip.

Returns:

the module metadata

getResourceData

public List<CmsResourceImportData> getResourceData()

Gets the list of resource data objects for the manifest entries.

Returns:

the resource data objects

setCms

public void setCms(CmsObject cms)

Sets the CMS object.

Parameters:

cms - the CMS object to set

setModule

public void setModule(CmsModule module)

Sets the module metadata.

Parameters:

module - the module metadata