org.kuali.rice.krad.datadictionary
Interface DataDictionaryEntry

All Known Subinterfaces:
KNSDocumentEntry
All Known Implementing Classes:
BusinessObjectEntry, BusinessObjectEntry, DataDictionaryEntryBase, DataObjectEntry, DocumentEntry, MaintenanceDocumentEntry, MaintenanceDocumentEntry, TransactionalDocumentEntry, TransactionalDocumentEntry

public interface DataDictionaryEntry

Defines methods common to all DataDictionaryDefinition types. DD: The highest level objects in the data dictionary are of the following types: BusinessObjectEntry MaintenanceDocumentEntry TransactionalDocumentEntry JSTL: The data dictionary is exposed as a Map which is accessed by referring to the "DataDictionary" global constant. This Map contains the following kinds of entries keyed as indicated: Business Object Entries - Key = dataObjectClass name Value = Map created by BusinessObjectEntryMapper Maintenance Document entries - Key = DocumentType name Value = Map created by MaintenanceObjectEntryMapper Transactional Document entries - Key = DocumentType name Value = Map created by TransactionalDocumentEntryMapper All elements are exposed to JSTL as Maps (where the element has a unique key by which they can be retrieved), or Strings. For collections of elements having no unique key, the entry's position in the list (0, 1, etc.) is used as its index. All Maps (except the top-level DataDictionary one) are guaranteed to present their entries with an iteration order identical to the order in which the elements were defined in XML.


Method Summary
 void completeValidation()
          Kicks off complete entry-wide validation which couldn't be done earlier.
 AttributeDefinition getAttributeDefinition(String attributeName)
           
 String getFullClassName()
          Returns the full class name of the underlying object.
 String getJstlKey()
           
 List<RelationshipDefinition> getRelationships()
           
 StateMapping getStateMapping()
          StateMapping for this DataDictionaryEntry, this represents the states of this entry, their names, and where to find the state information on the model
 void setStateMapping(StateMapping stateMapping)
          Set the StateMapping object which represents state information for this entry
 

Method Detail

getJstlKey

String getJstlKey()
Returns:
String used as a globally-unique key for this entry's jstl-exported version

completeValidation

void completeValidation()
Kicks off complete entry-wide validation which couldn't be done earlier.

Throws:
CompletionException - if a problem arises during validation-completion

getAttributeDefinition

AttributeDefinition getAttributeDefinition(String attributeName)
Parameters:
attributeName -
Returns:
AttributeDefinition with the given name, or null if none with that name exists

getFullClassName

String getFullClassName()
Returns the full class name of the underlying object.


getRelationships

List<RelationshipDefinition> getRelationships()
Returns:
a Map containing all RelationshipDefinitions associated with this BusinessObjectEntry, indexed by relationshipName

getStateMapping

StateMapping getStateMapping()
StateMapping for this DataDictionaryEntry, this represents the states of this entry, their names, and where to find the state information on the model

Returns:
StateMapping object

setStateMapping

void setStateMapping(StateMapping stateMapping)
Set the StateMapping object which represents state information for this entry

Parameters:
stateMapping - StateMapping object


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.