org.opencms.file.types
Class CmsResourceTypeFolder

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

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsResourceType

public class CmsResourceTypeFolder
extends A_CmsResourceTypeFolderBase

Resource type descriptor for the type "folder".

Since:

6.0.0

Version:

$Revision: 1.23 $

Author:

Alexander Kandzior

Field Summary

static int	RESOURCE_TYPE_ID The type id of this resource.
static String	RESOURCE_TYPE_NAME The name of this resource type.

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

CmsResourceTypeFolder()
Default constructor, used to initialize member variables.

Method Summary

static int	getStaticTypeId() Returns the static type id of this (default) resource type.
static String	getStaticTypeName() Returns the static type name of this (default) resource type.
void	initConfiguration(String name, String id, String className) Special version of the configuration initialization used with resource types to set resource type, id and class name, required for the XML configuration.

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

addConfigurationParameter, addCopyResource, addDefaultProperty, addMappingType, changeLock, chflags, copyResourceToProject, createSibling, getCachePropertyDefault, getClassName, getConfiguration, getConfiguredCopyResources, getConfiguredDefaultProperties, getConfiguredMappings, getMacroResolver, getResourceType, getTypeId, getTypeName, importResource, 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

RESOURCE_TYPE_ID

public static final int RESOURCE_TYPE_ID

The type id of this resource.

See Also:

Constant Field Values

RESOURCE_TYPE_NAME

public static final String RESOURCE_TYPE_NAME

The name of this resource type.

See Also:

Constant Field Values

Constructor Detail

CmsResourceTypeFolder

public CmsResourceTypeFolder()

Default constructor, used to initialize member variables.

Method Detail

getStaticTypeId

public static int getStaticTypeId()

Returns the static type id of this (default) resource type.

Returns:

the static type id of this (default) resource type

getStaticTypeName

public static String getStaticTypeName()

Returns the static type name of this (default) resource type.

Returns:

the static type name of this (default) resource type

initConfiguration

public void initConfiguration(String name,
                              String id,
                              String className)
                       throws CmsConfigurationException

Description copied from interface: I_CmsResourceType

Special version of the configuration initialization used with resource types to set resource type, id and class name, required for the XML configuration.

Please note: Many resource types defined in the core have in fact a fixed resource type and a fixed id. Configurable name and id is used only for certain types.

The provided named class must implement this interface (I_CmsResourceType). Usually the provided class name should be the class name of the resource type instance, but this may be different in special cases or configuration errors. For example, if a module is imported that contains it's own resource type class files, the included class file are usually not be available until the server is restarted. If the named class given in the XML configuration (or module manifest.xml) is not available, or not implementing I_CmsResourceType, then CmsResourceTypeUnknown is used for the resource type instance.

Specified by:

initConfiguration in interface I_CmsResourceType

Overrides:

initConfiguration in class A_CmsResourceType

Parameters:

name - the resource type name

id - the resource type id

className - the class name of the resource type (read from the XML configuration)

Throws:

CmsConfigurationException - if the configuration is invalid

See Also:

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