org.opencms.workplace.threads
Class CmsXmlContentRepairSettings

java.lang.Object
  org.opencms.workplace.threads.CmsXmlContentRepairSettings

public final class CmsXmlContentRepairSettings
extends java.lang.Object

Settings object that provides the settings to repair XML content resources in the OpenCms virtual file system (VFS).

Since:

6.2.0

Version:

$Revision: 1.7 $

Author:

Andreas Zahner

Constructor Summary

CmsXmlContentRepairSettings(CmsObject cms)
Default constructor with cms object that is used for VFS path validation.

Method Summary

java.lang.String	getResourceType() Returns the resource type name of the XML contents to process.
protected int	getResourceTypeId() Returns the resource type ID of the XML contents to process.
java.lang.String	getVfsFolder() Returns the VFS folder under which XML contents will be processed recursively.
boolean	isForce() Checks if to force the reparation.
boolean	isIncludeSubFolders() Returns the flag indicating if resources in sub folders should be repaired, too.
void	setForce(boolean force) Sets the force reparation flag.
void	setIncludeSubFolders(boolean includeSubFolders) Sets the flag indicating if resources in sub folders should be repaired, too.
void	setResourceType(java.lang.String resourceType) Sets the resource type name of the XML contents to process.
void	setVfsFolder(java.lang.String vfsFolder) Sets the VFS folder under which XML contents will be processed recursively.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsXmlContentRepairSettings

public CmsXmlContentRepairSettings(CmsObject cms)

Default constructor with cms object that is used for VFS path validation.

Parameters:

cms - the current users context to check the VFS path information

Method Detail

getResourceType

public java.lang.String getResourceType()

Returns the resource type name of the XML contents to process.

Returns:

the resource type name of the XML contents to process

getVfsFolder

public java.lang.String getVfsFolder()

Returns the VFS folder under which XML contents will be processed recursively.

Returns:

the VFS folder under which XML contents will be processed recursively

isForce

public boolean isForce()

Checks if to force the reparation.

Returns:

true if to force the reparation

isIncludeSubFolders

public boolean isIncludeSubFolders()

Returns the flag indicating if resources in sub folders should be repaired, too.

Returns:

the flag indicating if resources in sub folders should be repaired, too

setForce

public void setForce(boolean force)

Sets the force reparation flag.

Parameters:

force - the force reparation flag to set

setIncludeSubFolders

public void setIncludeSubFolders(boolean includeSubFolders)

Sets the flag indicating if resources in sub folders should be repaired, too.

Parameters:

includeSubFolders - the flag indicating if resources in sub folders should be repaired, too

setResourceType

public void setResourceType(java.lang.String resourceType)

Sets the resource type name of the XML contents to process.

Parameters:

resourceType - the resource type name of the XML contents to process

setVfsFolder

public void setVfsFolder(java.lang.String vfsFolder)
                  throws CmsIllegalArgumentException

Sets the VFS folder under which XML contents will be processed recursively.

Parameters:

vfsFolder - the VFS folder under which XML contents will be processed recursively

Throws:

CmsIllegalArgumentException - if the given VFS path is not valid

getResourceTypeId

protected int getResourceTypeId()

Returns the resource type ID of the XML contents to process.

Returns:

the resource type ID of the XML contents to process