Package org.opencms.staticexport

Class CmsStaticExportData

java.lang.Object

org.opencms.staticexport.CmsStaticExportData

public class CmsStaticExportData
extends Object

Provides a data structure for the result of an export request.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
CmsStaticExportData(String vfsName, String rfsName, CmsResource resource, String parameters)	Creates a new static export data object.

Method Summary

Modifier and Type	Method	Description
String	getParameters()	Return the parameters of the resource to export.
CmsResource	getResource()	Returns the resource to export.
String	getRfsName()	Returns the rfs name of the resource to export.
String	getVfsName()	Returns the vfs name of the resource to export.
boolean	isDetailPage()	Returns true if this is the static export data for a detail page.
protected void	setIsDetailPage(boolean isDetailPage)	Changes the 'is detail page' flag in this export data instance.
protected void	setParameters(String parameters)	Sets the parameters.
protected void	setRfsName(String rfsName)	Sets the RFS name.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CmsStaticExportData

public CmsStaticExportData(String vfsName,
 String rfsName,
 CmsResource resource,
 String parameters)

Creates a new static export data object.

Parameters:

vfsName - the vfs name of the resource

rfsName - the rfs name of the resource

resource - the resource object

parameters - the parameter string of a resource

Method Details

getParameters

public String getParameters()

Return the parameters of the resource to export.

Returns:

the parameter map

getResource

public CmsResource getResource()

Returns the resource to export.

Returns:

the resource to export

getRfsName

public String getRfsName()

Returns the rfs name of the resource to export.

Returns:

the rfs name of the resource to export

getVfsName

public String getVfsName()

Returns the vfs name of the resource to export.

Returns:

the vfs name of the resource to export

isDetailPage

public boolean isDetailPage()

Returns true if this is the static export data for a detail page.

Returns:

true if this is the static export data for a detail page

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

setIsDetailPage

protected void setIsDetailPage(boolean isDetailPage)

Changes the 'is detail page' flag in this export data instance.

Parameters:

isDetailPage - the new value for the flag

setParameters

protected void setParameters(String parameters)

Sets the parameters.

Parameters:

parameters - the parameters to set

setRfsName

protected void setRfsName(String rfsName)

Sets the RFS name.

Parameters:

rfsName - the RFS name to set