org.opencms.file.types
Class CmsResourceTypeFolderExtended

java.lang.Object
  extended by org.opencms.file.types.A_CmsResourceType
      extended by org.opencms.file.types.A_CmsResourceTypeFolderBase
          extended by 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.16 $
Author:
Alexander Kandzior, Andreas Zahner

Field Summary
static java.lang.String CONFIGURATION_FOLDER_CLASS
          Configuration key for the optional folder class name.
static java.lang.String CONFIGURATION_FOLDER_CLASS_PARAMS
          Configuration key for the optional folder class parameters.
 
Fields inherited from class org.opencms.file.types.A_CmsResourceType
CONFIGURATION_INTERNAL, m_addititionalModuleResourceType, m_className, m_copyResources, m_defaultProperties, m_frozen, m_mappings, m_typeId, m_typeName, MACRO_RESOURCE_FOLDER_PATH, MACRO_RESOURCE_FOLDER_PATH_TOUCH, 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(java.lang.String paramName, java.lang.String paramValue)
          Adds a configuration parameter to this parameter configurable class instance.
 java.util.Map getConfiguration()
          Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.
 java.lang.String getFolderClassName()
          Returns the (optional) configured folder class name for this folder.
 java.lang.String getFolderClassParams()
          Returns the (optional) configured folder class parameters name for this folder.
 
Methods inherited from class org.opencms.file.types.A_CmsResourceTypeFolderBase
chtype, copyResource, createResource, getLoaderId, isFolder, moveResource, replaceResource, setDateExpired, setDateLastModified, setDateReleased, undelete, undoChanges
 
Methods inherited from class org.opencms.file.types.A_CmsResourceType
addCopyResource, addDefaultProperty, addMappingType, changeLock, chflags, copyResourceToProject, createRelations, createSibling, deleteResource, equals, getCachePropertyDefault, getClassName, getConfiguredCopyResources, getConfiguredDefaultProperties, getConfiguredMappings, getMacroResolver, getResourceType, getTypeId, getTypeName, hashCode, importResource, initConfiguration, initConfiguration, initConfiguration, initialize, isAdditionalModuleResourceType, isDirectEditable, isIdentical, lockResource, processCopyResources, processDefaultProperties, removeResourceFromProject, restoreResource, restoreResourceBackup, setAdditionalModuleResourceType, toString, unlockResource, updateRelationForUndo, writeFile, writePropertyObject, writePropertyObjects
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CONFIGURATION_FOLDER_CLASS

public static final java.lang.String CONFIGURATION_FOLDER_CLASS
Configuration key for the optional folder class name.

See Also:
Constant Field Values

CONFIGURATION_FOLDER_CLASS_PARAMS

public static final java.lang.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(java.lang.String paramName,
                                      java.lang.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 java.util.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 java.lang.String getFolderClassName()
Returns the (optional) configured folder class name for this folder.

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

getFolderClassParams

public java.lang.String getFolderClassParams()
Returns the (optional) configured folder class parameters name for this folder.

Returns:
the (optional) configured folder class parameters for this folder