org.opencms.file.types
Class CmsResourceTypeFolderExtended

java.lang.Object
  org.opencms.file.types.A_CmsResourceType
      org.opencms.file.types.A_CmsResourceTypeFolderBase
          org.opencms.file.types.CmsResourceTypeFolderExtended

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsResourceType

public class CmsResourceTypeFolderExtended
extends A_CmsResourceTypeFolderBase

Resource type descriptor for extended folder types (like for example the workplace galleries).

This type extends a folder but has a configurable type id and type name. Optionally, a workplace class name for the type and a parameter String can be provided.

Since:

6.0.0

Version:

$Revision: 1.9 $

Author:

Alexander Kandzior, Andreas Zahner

Field Summary

static String	CONFIGURATION_FOLDER_CLASS Configuration key for the optional folder class name.
static String	CONFIGURATION_FOLDER_CLASS_PARAMS Configuration key for the optional folder class parameters.

Fields inherited from class org.opencms.file.types.A_CmsResourceType

m_addititionalModuleResourceType, m_className, m_copyResources, m_defaultProperties, m_frozen, m_mappings, m_typeId, m_typeName, MACRO_RESOURCE_FOLDER_PATH, MACRO_RESOURCE_NAME, MACRO_RESOURCE_PARENT_PATH, MACRO_RESOURCE_ROOT_PATH, MACRO_RESOURCE_SITE_PATH

Fields inherited from interface org.opencms.file.types.I_CmsResourceType

ADD_MAPPING_METHOD, ADD_RESOURCE_TYPE_METHOD, CONFIGURATION_PROPERTY_CREATE, CONFIGURATION_RESOURCE_TYPE_ID, CONFIGURATION_RESOURCE_TYPE_NAME, PROPERTY_ON_RESOURCE, PROPERTY_ON_STRUCTURE

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

CmsResourceTypeFolderExtended()

Method Summary

void	addConfigurationParameter(String paramName, String paramValue) Adds a configuration parameter to this parameter configurable class instance.
Map	getConfiguration() Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.
String	getFolderClassName() Returns the (optional) configured folder class name for this folder.
String	getFolderClassParams() Returns the (optional) configured folder class parameters name for this folder.

Methods inherited from class org.opencms.file.types.A_CmsResourceTypeFolderBase

changeLastModifiedProjectId, chtype, copyResource, createResource, deleteResource, getLoaderId, isFolder, moveResource, replaceResource, restoreResourceBackup, setDateExpired, setDateLastModified, setDateReleased, undoChanges

Methods inherited from class org.opencms.file.types.A_CmsResourceType

addCopyResource, addDefaultProperty, addMappingType, changeLock, chflags, copyResourceToProject, createSibling, getCachePropertyDefault, getClassName, getConfiguredCopyResources, getConfiguredDefaultProperties, getConfiguredMappings, getMacroResolver, getResourceType, getTypeId, getTypeName, importResource, initConfiguration, initConfiguration, initConfiguration, initialize, isAdditionalModuleResourceType, isDirectEditable, lockResource, processCopyResources, processDefaultProperties, setAdditionalModuleResourceType, toString, unlockResource, writeFile, writePropertyObject, writePropertyObjects

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_FOLDER_CLASS

public static final String CONFIGURATION_FOLDER_CLASS

Configuration key for the optional folder class name.

See Also:

Constant Field Values

CONFIGURATION_FOLDER_CLASS_PARAMS

public static final String CONFIGURATION_FOLDER_CLASS_PARAMS

Configuration key for the optional folder class parameters.

See Also:

Constant Field Values

Constructor Detail

CmsResourceTypeFolderExtended

public CmsResourceTypeFolderExtended()

Method Detail

addConfigurationParameter

public void addConfigurationParameter(String paramName,
                                      String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Overrides:

addConfigurationParameter in class A_CmsResourceType

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

A_CmsResourceType.addConfigurationParameter(java.lang.String, java.lang.String)

getConfiguration

public Map getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.

All elements in the configuration are key, value String pairs, set using the I_CmsConfigurationParameterHandler.addConfigurationParameter(String, String) method during initialization of the loader.

Implementations will (should) not to return a direct reference to the internal configuration but just a copy of it, to avoid unwanted external manipulation.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Overrides:

getConfiguration in class A_CmsResourceType

Returns:

the configuration of this resource loader, or null

See Also:

A_CmsResourceType.getConfiguration()

getFolderClassName

public String getFolderClassName()

Returns the (optional) configured folder class name for this folder.

Returns:

the (optional) configured folder class name for this folder

getFolderClassParams

public String getFolderClassParams()

Returns the (optional) configured folder class parameters name for this folder.

Returns:

the (optional) configured folder class parameters for this folder