net.datacrow.core.modules
Class DcParentModule

java.lang.Object
  extended by net.datacrow.core.modules.DcModule
      extended by net.datacrow.core.modules.DcParentModule
All Implemented Interfaces:
java.lang.Comparable<DcModule>
Direct Known Subclasses:
ContainerModule, UserModule

public class DcParentModule
extends DcModule

A parent module is a parent to another module. The child module and its items depend on the existence of this module.

Author:
Robert Jan van der Waals
See Also:
DcChildModule

Field Summary
 
Fields inherited from class net.datacrow.core.modules.DcModule
_TYPE_ASSOCIATE_MODULE, _TYPE_EXTERNALREFERENCE_MODULE, _TYPE_MAPPING_MODULE, _TYPE_MEDIA_MODULE, _TYPE_MODULE, _TYPE_PROPERTY_MODULE, _TYPE_TEMPLATE_MODULE, insertView, searchView
 
Constructor Summary
DcParentModule(int index, boolean topModule, java.lang.String name, java.lang.String description, java.lang.String objectName, java.lang.String objectNamePlural, java.lang.String tableName, java.lang.String tableShortName)
          Creates a new instance.
DcParentModule(XmlModule xmlModule)
          Creates a new module based on a XML definition.
 
Method Summary
 boolean equals(java.lang.Object o)
           
 boolean isParentModule()
          Indicates if this module is a parent module.
 boolean isTopModule()
          Indicates if this module is a top module.
 
Methods inherited from class net.datacrow.core.modules.DcModule
addField, addValueEnhancer, applySettings, canBeLend, compareTo, createItem, delete, deliversOnlineService, getChartPanel, getChild, getCurrentInsertView, getCurrentSearchView, getDefaultData, getDefaultSortFieldIdx, getDescription, getDisplayFieldIdx, getDisplayIndex, getField, getField, getFieldCount, getFieldDefinitions, getFieldIndices, getFields, getFileField, getFileRenamerDialog, getFilterForm, getIcon16, getIcon16Filename, getIcon32, getIcon32Filename, getIconField, getImporter, getImporterClass, getIndex, getInsertView, getItem, getItemForm, getItemPluralResourceKey, getItemResourceKey, getKeyStroke, getLabel, getMenuBar, getMinimalFields, getModuleResourceKey, getName, getNameFieldIdx, getObjectName, getObjectNamePlural, getOnlineServices, getParent, getParentReferenceFieldIndex, getPersistentField, getPropertyModule, getQuickView, getQuickViewFieldDefinitions, getSearchView, getSetting, getSettings, getSupportedViews, getSynchronizer, getSystemDisplayFieldIdx, getSystemField, getSystemObjectName, getSystemObjectNamePlural, getTableName, getTableShortName, getTemplateModule, getType, getViews, getWebFieldDefinitions, getXmlModule, hasActualReferenceTo, hasDependingModules, hashCode, hasInsertView, hasReferenceTo, hasReports, hasSearchView, initializeFields, initializeMultiReferenceFields, initializeSettings, initializeSystemFields, initializeUI, isAbstract, isChildModule, isContainerManaged, isCustomFieldsAllowed, isCustomModule, isDefaultDataLoaded, isEditingAllowed, isEnabled, isEnabled, isFileBacked, isHasImages, isHasReferences, isNew, isSearchViewInitialized, isSelectableInUI, isServingMultipleModules, isValid, release, removeEnhancers, setChild, setDefaultDataLoaded, setIcon16, setIcon32, setNew, setServingMultipleModules, setSetting, setValid, setXmlModule, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DcParentModule

public DcParentModule(XmlModule xmlModule)
Creates a new module based on a XML definition.

Parameters:
module -

DcParentModule

public DcParentModule(int index,
                      boolean topModule,
                      java.lang.String name,
                      java.lang.String description,
                      java.lang.String objectName,
                      java.lang.String objectNamePlural,
                      java.lang.String tableName,
                      java.lang.String tableShortName)
Creates a new instance.

Parameters:
index - The module index.
topModule - Indicates if the module is a top module. Top modules are allowed to be displayed in the module bar and can be enabled or disabled.
name - The internal unique name of the module.
description - The module description
objectName - The name of the items belonging to this module.
objectNamePlural - The plural name of the items belonging to this module.
tableName - The database table name for this module.
tableShortName - The database table short name for this module.
Method Detail

isParentModule

public boolean isParentModule()
Indicates if this module is a parent module. Always returns true.

Overrides:
isParentModule in class DcModule

isTopModule

public boolean isTopModule()
Indicates if this module is a top module. Top modules are allowed to be displayed in the module bar and can be enabled or disabled.

Overrides:
isTopModule in class DcModule

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class DcModule