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 java.lang.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
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract CmsContentCheckResource
executeContentCheck(org.opencms.file.CmsObject cms, CmsContentCheckResource testResource)
Main method of the content check.java.lang.String
getConfirmationMessage()
abstract java.lang.String
getDialogParameterName()
Defines the name of the parameter which is used by the CmsContentCheckDialog to enable or disable the content check.java.lang.String
getDisabledHelpText()
java.lang.String
getGroup()
abstract java.lang.String
getHelpText()
abstract java.lang.String
getIconPath()
abstract java.lang.String
getLink()
abstract java.util.List
getMessageBundles()
Gets a list of all required message bundles by this content check.abstract java.lang.String
getName()
Gets the name of this content check.java.util.Map
getParameters(org.opencms.workplace.CmsWorkplace wp)
abstract java.lang.String
getPath()
abstract float
getPosition()
abstract java.lang.String
getShortName()
java.lang.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, java.lang.String resourcePath)
-
-
-
Constructor Detail
-
A_CmsContentCheck
public A_CmsContentCheck()
-
-
Method Detail
-
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 interfaceI_CmsContentCheck
- Parameters:
cms
- the CmsObjecttestResource
- 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 java.lang.String getConfirmationMessage()
- Specified by:
getConfirmationMessage
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.getConfirmationMessage()
-
getDialogParameterName
public abstract java.lang.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 interfaceI_CmsContentCheck
- Returns:
- the name of the dialog parameter.
- See Also:
I_CmsContentCheck.getDialogParameterName()
-
getDisabledHelpText
public java.lang.String getDisabledHelpText()
- Specified by:
getDisabledHelpText
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.getDisabledHelpText()
-
getGroup
public java.lang.String getGroup()
- Specified by:
getGroup
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.getGroup()
-
getHelpText
public abstract java.lang.String getHelpText()
- Specified by:
getHelpText
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.getHelpText()
-
getIconPath
public abstract java.lang.String getIconPath()
- Specified by:
getIconPath
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.getIconPath()
-
getLink
public abstract java.lang.String getLink()
- Specified by:
getLink
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.getLink()
-
getMessageBundles
public abstract java.util.List getMessageBundles()
Description copied from interface:I_CmsContentCheck
Gets a list of all required message bundles by this content check.- Specified by:
getMessageBundles
in interfaceI_CmsContentCheck
- Returns:
- list of message bundle names
- See Also:
I_CmsContentCheck.getMessageBundles()
-
getName
public abstract java.lang.String getName()
Description copied from interface:I_CmsContentCheck
Gets the name of this content check.- Specified by:
getName
in interfaceI_CmsContentCheck
- Specified by:
getName
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- Returns:
- name of the content check
- See Also:
I_CmsToolHandler.getName()
-
getParameters
public java.util.Map getParameters(org.opencms.workplace.CmsWorkplace wp)
- Specified by:
getParameters
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.getParameters(org.opencms.workplace.CmsWorkplace)
-
getPath
public abstract java.lang.String getPath()
- Specified by:
getPath
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.getPath()
-
getPosition
public abstract float getPosition()
- Specified by:
getPosition
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.getPosition()
-
getShortName
public abstract java.lang.String getShortName()
- Specified by:
getShortName
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.getShortName()
-
getSmallIconPath
public java.lang.String getSmallIconPath()
- Specified by:
getSmallIconPath
in interfaceorg.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 interfaceI_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 interfaceI_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 interfaceorg.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 interfaceorg.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 interfaceorg.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 interfaceorg.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 interfaceI_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, java.lang.String resourcePath)
- Specified by:
setup
in interfaceorg.opencms.workplace.tools.I_CmsToolHandler
- See Also:
I_CmsToolHandler.setup(org.opencms.file.CmsObject, org.opencms.workplace.tools.CmsToolRootHandler, java.lang.String)
-
-