com.wewebu.ow.server.dmsdialogs.views.classes
Class OwObjectClassSelectionCfg

java.lang.Object
  extended by com.wewebu.ow.server.dmsdialogs.views.classes.OwObjectClassSelectionCfg

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

Since:
4.1.0.0

Field Summary
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.
 
Method Summary
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()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EL_OBJECT_CLASS_SELECTION

public static final String EL_OBJECT_CLASS_SELECTION
The root XML element for this configuration.

See Also:
Constant Field Values

EL_OBJECT_CLASS

public static final String EL_OBJECT_CLASS
The XML element to be used for each entry in the configuration.

See Also:
Constant Field Values

ATT_INCLUDE_SUB_CLASS

public static final String ATT_INCLUDE_SUB_CLASS
See Also:
Constant Field Values
Method Detail

getRootClasses

public Set<OwRootClassCfg> getRootClasses()
Returns:
the rootClasses

get

public OwRootClassCfg get(String rootClassName)
Parameters:
rootClassName - a class name
Returns:
null if this class was not specified as a root class in this configuration

hasDefaultClass

public boolean hasDefaultClass()
Returns:
true if only one root class was defined and it's OwRootClassCfg.isIncludeSubclasses() is false.

getDefaultClass

public OwRootClassCfg getDefaultClass()
Returns:
null of there is no root class defined or there is more than 1 root class defined.
See Also:
hasDefaultClass()

createSingleClassConfiguration

public static OwObjectClassSelectionCfg createSingleClassConfiguration(String defaultClassName)
Factory method to create a configuration with single/default class name.

Parameters:
defaultClassName - String symbolic name or id of the default name
Returns:
OwObjectClassSelectionCfg
Since:
4.1.1.0

fromPluginXml

public static OwObjectClassSelectionCfg fromPluginXml(OwXMLUtil pluginXMLCfg)
                                               throws OwConfigurationException
Creates an instance of this configuration from the plugin's XML configuration.

Ex.
<ObjectClasses>
  <ObjectClass includeSubClasses="true">class_name</ObjectClass>
</ObjectClasses>

Parameters:
pluginXMLCfg - the plugin's xml configuration.
Returns:
an instance of myself.
Throws:
OwConfigurationException

createEmptyConfiguration

public static OwObjectClassSelectionCfg createEmptyConfiguration()
Factory to create an empty OwObjectClassSelectionCfg instance.

Returns:
OwObjectClassSelectionCfg
Since:
4.1.1.0

addRootSelectionClass

public static void addRootSelectionClass(OwObjectClassSelectionCfg cfg,
                                         String rootClassName,
                                         boolean includeSubClasses)
Add new root class configuration, and define if subclasses should be also visible.

Parameters:
cfg - OwObjectClassSelectionCfg
rootClassName - String
includeSubClasses - boolean
Since:
4.1.1.0
See Also:
createEmptyConfiguration()


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.