Package org.opencms.workflow
Class A_CmsWorkflowManager
- java.lang.Object
-
- org.opencms.workflow.A_CmsWorkflowManager
-
- All Implemented Interfaces:
I_CmsWorkflowManager
- Direct Known Subclasses:
CmsDefaultWorkflowManager
public abstract class A_CmsWorkflowManager extends java.lang.Object implements I_CmsWorkflowManager
Abstract class which provides common functionality for workflow managers, like initialization of the configuration parameters.
-
-
Field Summary
Fields Modifier and Type Field Description protected CmsObject
m_adminCms
The CMS context with admin privileges.protected java.util.Map<java.lang.String,java.lang.String>
m_parameters
The map of configuration parameters.
-
Constructor Summary
Constructors Constructor Description A_CmsWorkflowManager()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.util.Locale
getLocale(CmsObject userCms)
Gets the locale to use for a given CMS context.protected java.lang.String
getParameter(java.lang.String key, java.lang.String defaultValue)
Gets the configuration parameter for a given key, and if it doesn't find one, returns a default value.java.util.Map<java.lang.String,java.lang.String>
getParameters()
Gets the parameters of the workflow manager.void
initialize(CmsObject adminCms)
Initializes this workflow manager instance.void
setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Sets the configuration parameters of the workflow manager.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.opencms.workflow.I_CmsWorkflowManager
createFormatter, executeAction, executeAction, getManageableProjects, getPublishListToken, getRealOrVirtualProject, getResourceLimit, getWorkflowForWorkflowProject, getWorkflowResources, getWorkflows
-
-
-
-
Field Detail
-
m_adminCms
protected CmsObject m_adminCms
The CMS context with admin privileges.
-
m_parameters
protected java.util.Map<java.lang.String,java.lang.String> m_parameters
The map of configuration parameters.
-
-
Constructor Detail
-
A_CmsWorkflowManager
public A_CmsWorkflowManager()
-
-
Method Detail
-
getParameters
public java.util.Map<java.lang.String,java.lang.String> getParameters()
Gets the parameters of the workflow manager.- Specified by:
getParameters
in interfaceI_CmsWorkflowManager
- Returns:
- the configuration parameters of the workflow manager
-
initialize
public void initialize(CmsObject adminCms)
Description copied from interface:I_CmsWorkflowManager
Initializes this workflow manager instance.- Specified by:
initialize
in interfaceI_CmsWorkflowManager
- Parameters:
adminCms
- the CMS context with admin privileges- See Also:
I_CmsWorkflowManager.initialize(org.opencms.file.CmsObject)
-
setParameters
public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Sets the configuration parameters of the workflow manager.- Specified by:
setParameters
in interfaceI_CmsWorkflowManager
- Parameters:
parameters
- the map of configuration parameters
-
getLocale
protected java.util.Locale getLocale(CmsObject userCms)
Gets the locale to use for a given CMS context.- Parameters:
userCms
- the CMS context- Returns:
- the locale to use
-
getParameter
protected java.lang.String getParameter(java.lang.String key, java.lang.String defaultValue)
Gets the configuration parameter for a given key, and if it doesn't find one, returns a default value.- Parameters:
key
- the configuration keydefaultValue
- the default value to use when the configuration entry isn't found- Returns:
- the configuration value
-
-