org.opencms.file.types
Class CmsResourceTypeUnknownFolder

java.lang.Object
  extended byorg.opencms.file.types.A_CmsResourceType
      extended byorg.opencms.file.types.A_CmsResourceTypeFolderBase
          extended byorg.opencms.file.types.CmsResourceTypeUnknownFolder
All Implemented Interfaces:
I_CmsConfigurationParameterHandler, I_CmsResourceType

public class CmsResourceTypeUnknownFolder
extends A_CmsResourceTypeFolderBase

Resource type descriptor for unknown folder types.

This will be used for folder corpses when the resource type is not configured.

The most common use case is when deleting a module with the resource type definition, but not the content that uses that resource type definition.

Since:
7.0.0
Version:
$Revision: 1.4 $
Author:
Michael Moossen

Field Summary
static int RESOURCE_TYPE_ID
          The type id of this resource type.
 
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_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
CmsResourceTypeUnknownFolder()
          Default constructor, used to initialize member variables.
 
Method Summary
static int getStaticTypeId()
          Returns the static type id of this (default) resource type.
static java.lang.String getStaticTypeName()
          Returns the static type name of this (default) resource type.
 void initConfiguration(java.lang.String name, java.lang.String id, java.lang.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
chtype, copyResource, createResource, getLoaderId, isFolder, moveResource, replaceResource, restoreResourceBackup, setDateExpired, setDateLastModified, setDateReleased, undelete, undoChanges
 
Methods inherited from class org.opencms.file.types.A_CmsResourceType
addConfigurationParameter, addCopyResource, addDefaultProperty, addMappingType, changeLock, chflags, copyResourceToProject, createRelations, createSibling, deleteResource, equals, getCachePropertyDefault, getClassName, getConfiguration, getConfiguredCopyResources, getConfiguredDefaultProperties, getConfiguredMappings, getMacroResolver, getResourceType, getTypeId, getTypeName, hashCode, importResource, initConfiguration, initConfiguration, initialize, isAdditionalModuleResourceType, isDirectEditable, isIdentical, lockResource, processCopyResources, processDefaultProperties, removeResourceFromProject, restoreResource, setAdditionalModuleResourceType, toString, unlockResource, updateRelationForUndo, writeFile, writePropertyObject, writePropertyObjects
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE_TYPE_ID

public static final int RESOURCE_TYPE_ID
The type id of this resource type.

See Also:
Constant Field Values
Constructor Detail

CmsResourceTypeUnknownFolder

public CmsResourceTypeUnknownFolder()
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 java.lang.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(java.lang.String name,
                              java.lang.String id,
                              java.lang.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
Throws:
CmsConfigurationException
See Also:
A_CmsResourceType.initConfiguration(java.lang.String, java.lang.String, String)