Package org.opencms.workplace.tools.content.check

Class A_CmsContentCheck

java.lang.Object

org.opencms.workplace.tools.content.check.A_CmsContentCheck

All Implemented Interfaces:

I_CmsContentCheck, org.opencms.workplace.tools.I_CmsToolHandler

Direct Known Subclasses:

CmsContentCheckProperty

public abstract class A_CmsContentCheck
extends Object
implements I_CmsContentCheck, org.opencms.workplace.tools.I_CmsToolHandler

Abstract class for a CmsContentCheck.

Since:

6.1.2

Field Summary

Fields inherited from interface org.opencms.workplace.tools.content.check.I_CmsContentCheck

PARAMETER

Constructor Summary

Constructors

Constructor	Description
A_CmsContentCheck()

Method Summary

Modifier and Type	Method	Description
abstract CmsContentCheckResource	executeContentCheck(org.opencms.file.CmsObject cms, CmsContentCheckResource testResource)	Main method of the content check.
String	getConfirmationMessage()
abstract String	getDialogParameterName()	Defines the name of the parameter which is used by the CmsContentCheckDialog to enable or disable the content check.
String	getDisabledHelpText()
String	getGroup()
abstract String	getHelpText()
abstract String	getIconPath()
abstract String	getLink()
abstract List	getMessageBundles()	Gets a list of all required message bundles by this content check.
abstract String	getName()	Gets the name of this content check.
Map	getParameters(org.opencms.workplace.CmsWorkplace wp)
abstract String	getPath()
abstract float	getPosition()
abstract String	getShortName()
String	getSmallIconPath()
abstract void	init(org.opencms.file.CmsObject cms)	Initializer for the content check.
abstract boolean	isActive()	Signals if this content check is active or not.
boolean	isEnabled(org.opencms.file.CmsObject cms)
boolean	isEnabled(org.opencms.workplace.CmsWorkplace wp)
boolean	isVisible(org.opencms.file.CmsObject cms)
boolean	isVisible(org.opencms.workplace.CmsWorkplace wp)
abstract void	setActive(boolean value)	Sets the active flag for the content check.
boolean	setup(org.opencms.file.CmsObject cms, org.opencms.workplace.tools.CmsToolRootHandler root, String resourcePath)

Methods inherited from class java.lang.Object

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

Constructor Details

A_CmsContentCheck

public A_CmsContentCheck()

Method Details

executeContentCheck

public abstract CmsContentCheckResource executeContentCheck(org.opencms.file.CmsObject cms,
 CmsContentCheckResource testResource)
                                                     throws org.opencms.main.CmsException

Description copied from interface: I_CmsContentCheck

Main method of the content check. It holds the implementation of the content check.

Specified by:

executeContentCheck in interface I_CmsContentCheck

Parameters:

cms - the CmsObject

testResource - a CmsContentTestResource containing the results of previous tests

Returns:

the updated testResouce containing the results of the content check

Throws:

org.opencms.main.CmsException - if an error occurs

See Also:

• I_CmsContentCheck.executeContentCheck(org.opencms.file.CmsObject, org.opencms.workplace.tools.content.check.CmsContentCheckResource)

getConfirmationMessage

public String getConfirmationMessage()

Specified by:

getConfirmationMessage in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getConfirmationMessage()

getDialogParameterName

public abstract String getDialogParameterName()

Description copied from interface: I_CmsContentCheck

Defines the name of the parameter which is used by the CmsContentCheckDialog to enable or disable the content check.

Specified by:

getDialogParameterName in interface I_CmsContentCheck

Returns:

the name of the dialog parameter.

See Also:

• I_CmsContentCheck.getDialogParameterName()

getDisabledHelpText

public String getDisabledHelpText()

Specified by:

getDisabledHelpText in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getDisabledHelpText()

getGroup

public String getGroup()

Specified by:

getGroup in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getGroup()

getHelpText

public abstract String getHelpText()

Specified by:

getHelpText in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getHelpText()

getIconPath

public abstract String getIconPath()

Specified by:

getIconPath in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getIconPath()

getLink

public abstract String getLink()

Specified by:

getLink in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getLink()

getMessageBundles

public abstract List getMessageBundles()

Description copied from interface: I_CmsContentCheck

Gets a list of all required message bundles by this content check.

Specified by:

getMessageBundles in interface I_CmsContentCheck

Returns:

list of message bundle names

See Also:

• I_CmsContentCheck.getMessageBundles()

getName

public abstract String getName()

Description copied from interface: I_CmsContentCheck

Gets the name of this content check.

Specified by:

getName in interface I_CmsContentCheck

Specified by:

getName in interface org.opencms.workplace.tools.I_CmsToolHandler

Returns:

name of the content check

See Also:

• I_CmsToolHandler.getName()

getParameters

public Map getParameters(org.opencms.workplace.CmsWorkplace wp)

Specified by:

getParameters in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getParameters(org.opencms.workplace.CmsWorkplace)

getPath

public abstract String getPath()

Specified by:

getPath in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getPath()

getPosition

public abstract float getPosition()

Specified by:

getPosition in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getPosition()

getShortName

public abstract String getShortName()

Specified by:

getShortName in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getShortName()

getSmallIconPath

public String getSmallIconPath()

Specified by:

getSmallIconPath in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.getSmallIconPath()

init

public abstract void init(org.opencms.file.CmsObject cms)
                   throws org.opencms.main.CmsException

Description copied from interface: I_CmsContentCheck

Initializer for the content check.

Specified by:

init in interface I_CmsContentCheck

Parameters:

cms - the current CmsObject

Throws:

org.opencms.main.CmsException - if an error occurs

See Also:

• I_CmsContentCheck.init(org.opencms.file.CmsObject)

isActive

public abstract boolean isActive()

Description copied from interface: I_CmsContentCheck

Signals if this content check is active or not.

Specified by:

isActive in interface I_CmsContentCheck

Returns:

true if this content check is active, false otherwise.

See Also:

• I_CmsContentCheck.isActive()

isEnabled

public boolean isEnabled(org.opencms.file.CmsObject cms)

Specified by:

isEnabled in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.isEnabled(org.opencms.file.CmsObject)

isEnabled

public boolean isEnabled(org.opencms.workplace.CmsWorkplace wp)

Specified by:

isEnabled in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.isEnabled(org.opencms.workplace.CmsWorkplace)

isVisible

public boolean isVisible(org.opencms.file.CmsObject cms)

Specified by:

isVisible in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.isVisible(org.opencms.file.CmsObject)

isVisible

public boolean isVisible(org.opencms.workplace.CmsWorkplace wp)

Specified by:

isVisible in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.isVisible(org.opencms.workplace.CmsWorkplace)

setActive

public abstract void setActive(boolean value)

Description copied from interface: I_CmsContentCheck

Sets the active flag for the content check.

Specified by:

setActive in interface I_CmsContentCheck

Parameters:

value - the value for the active flag

See Also:

• I_CmsContentCheck.setActive(boolean)

setup

public boolean setup(org.opencms.file.CmsObject cms,
 org.opencms.workplace.tools.CmsToolRootHandler root,
 String resourcePath)

Specified by:

setup in interface org.opencms.workplace.tools.I_CmsToolHandler

See Also:

• I_CmsToolHandler.setup(org.opencms.file.CmsObject, org.opencms.workplace.tools.CmsToolRootHandler, java.lang.String)