net.datacrow.core.modules
Class ItemModule

java.lang.Object
  extended by net.datacrow.core.modules.DcModule
      extended by net.datacrow.core.modules.DcChildModule
          extended by net.datacrow.core.modules.ItemModule
All Implemented Interfaces:
java.lang.Comparable<DcModule>, IChildModule

public class ItemModule
extends DcChildModule

The item module represents container managed items. The container module is a so called abstract module. This means that this module does not own or manages any items directly.

Author:
Robert Jan van der Waals

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
ItemModule(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.
ItemModule(XmlModule module)
          Creates a new module based on a XML definition.
 
Method Summary
 boolean equals(java.lang.Object o)
           
 int getParentReferenceFieldIndex()
          Retrieves the index for the field holding the reference to the parent item.
 boolean isContainerManaged()
          Indicates if the module is managed by (can belong to) a container.
 
Methods inherited from class net.datacrow.core.modules.DcChildModule
getItemView, getMinimalFields, getSupportedViews, initializeUI, isChildModule, isTopModule
 
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, getModuleResourceKey, getName, getNameFieldIdx, getObjectName, getObjectNamePlural, getOnlineServices, getParent, getPersistentField, getPropertyModule, getQuickView, getQuickViewFieldDefinitions, getSearchView, getSetting, getSettings, getSynchronizer, getSystemDisplayFieldIdx, getSystemField, getSystemObjectName, getSystemObjectNamePlural, getTableName, getTableShortName, getTemplateModule, getType, getViews, getWebFieldDefinitions, getXmlModule, hasActualReferenceTo, hasDependingModules, hashCode, hasInsertView, hasReferenceTo, hasReports, hasSearchView, initializeFields, initializeMultiReferenceFields, initializeSettings, initializeSystemFields, isAbstract, isCustomFieldsAllowed, isCustomModule, isDefaultDataLoaded, isEditingAllowed, isEnabled, isEnabled, isFileBacked, isHasImages, isHasReferences, isNew, isParentModule, 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
 
Methods inherited from interface net.datacrow.core.modules.IChildModule
getIndex
 

Constructor Detail

ItemModule

public ItemModule(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.

ItemModule

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

Parameters:
module -
Method Detail

isContainerManaged

public boolean isContainerManaged()
Description copied from class: DcModule
Indicates if the module is managed by (can belong to) a container.

Overrides:
isContainerManaged in class DcModule
See Also:
ContainerModule, Container

getParentReferenceFieldIndex

public int getParentReferenceFieldIndex()
Description copied from class: DcModule
Retrieves the index for the field holding the reference to the parent item.

Overrides:
getParentReferenceFieldIndex in class DcModule
Returns:
The field index or -1 if not found.

equals

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