Package org.opencms.staticexport
Class CmsStaticExportData
- java.lang.Object
-
- org.opencms.staticexport.CmsStaticExportData
-
public class CmsStaticExportData extends java.lang.Object
Provides a data structure for the result of an export request.- Since:
- 6.0.0
-
-
Constructor Summary
Constructors Constructor Description CmsStaticExportData(java.lang.String vfsName, java.lang.String rfsName, CmsResource resource, java.lang.String parameters)
Creates a new static export data object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getParameters()
Return the parameters of the resource to export.CmsResource
getResource()
Returns the resource to export.java.lang.String
getRfsName()
Returns the rfs name of the resource to export.java.lang.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(java.lang.String parameters)
Sets the parameters.protected void
setRfsName(java.lang.String rfsName)
Sets the RFS name.java.lang.String
toString()
-
-
-
Constructor Detail
-
CmsStaticExportData
public CmsStaticExportData(java.lang.String vfsName, java.lang.String rfsName, CmsResource resource, java.lang.String parameters)
Creates a new static export data object.- Parameters:
vfsName
- the vfs name of the resourcerfsName
- the rfs name of the resourceresource
- the resource objectparameters
- the parameter string of a resource
-
-
Method Detail
-
getParameters
public java.lang.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 java.lang.String getRfsName()
Returns the rfs name of the resource to export.- Returns:
- the rfs name of the resource to export
-
getVfsName
public java.lang.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 java.lang.String toString()
- Overrides:
toString
in classjava.lang.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(java.lang.String parameters)
Sets the parameters.- Parameters:
parameters
- the parameters to set
-
setRfsName
protected void setRfsName(java.lang.String rfsName)
Sets the RFS name.- Parameters:
rfsName
- the RFS name to set
-
-