public class OwObjectClassSelectionCfg extends Object
Configuration to be used for selecting the class of a newly created document. Basically this is a filter for the classes to be shown to the user so he/she can choose upon. It gets its data from the plugin's XML configuration.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Modifier and Type | Field and Description |
---|---|
static String |
ATT_INCLUDE_SUB_CLASS |
static String |
EL_OBJECT_CLASS
The XML element to be used for each entry in the configuration.
|
static String |
EL_OBJECT_CLASS_SELECTION
The root XML element for this configuration.
|
Modifier and Type | Method and Description |
---|---|
static void |
addRootSelectionClass(OwObjectClassSelectionCfg cfg,
String rootClassName,
boolean includeSubClasses)
Add new root class configuration, and define if subclasses should be also visible.
|
static OwObjectClassSelectionCfg |
createEmptyConfiguration()
Factory to create an empty OwObjectClassSelectionCfg instance.
|
static OwObjectClassSelectionCfg |
createSingleClassConfiguration(String defaultClassName)
Factory method to create a configuration with single/default class name.
|
static OwObjectClassSelectionCfg |
fromPluginXml(OwXMLUtil pluginXMLCfg)
Creates an instance of this configuration from the plugin's XML configuration.
|
OwRootClassCfg |
get(String rootClassName) |
OwRootClassCfg |
getDefaultClass() |
Set<OwRootClassCfg> |
getRootClasses() |
boolean |
hasDefaultClass() |
public static final String EL_OBJECT_CLASS_SELECTION
public static final String EL_OBJECT_CLASS
public static final String ATT_INCLUDE_SUB_CLASS
public Set<OwRootClassCfg> getRootClasses()
public OwRootClassCfg get(String rootClassName)
rootClassName
- a class namepublic boolean hasDefaultClass()
OwRootClassCfg.isIncludeSubclasses()
is false.public OwRootClassCfg getDefaultClass()
hasDefaultClass()
public static OwObjectClassSelectionCfg createSingleClassConfiguration(String defaultClassName)
defaultClassName
- String symbolic name or id of the default namepublic static OwObjectClassSelectionCfg fromPluginXml(OwXMLUtil pluginXMLCfg) throws OwConfigurationException
Ex.
<ObjectClasses>
<ObjectClass includeSubClasses="true">class_name</ObjectClass>
</ObjectClasses>
pluginXMLCfg
- the plugin's XML configuration.OwConfigurationException
public static OwObjectClassSelectionCfg createEmptyConfiguration()
public static void addRootSelectionClass(OwObjectClassSelectionCfg cfg, String rootClassName, boolean includeSubClasses)
cfg
- OwObjectClassSelectionCfgrootClassName
- StringincludeSubClasses
- booleancreateEmptyConfiguration()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.