| org.kuali.core.service.DataDictionaryService
All known Subclasses: org.kuali.core.service.impl.DataDictionaryServiceImpl,
| DataDictionaryService | | public interface DataDictionaryService (Code) | | This interface defines the API for interacting with the data dictionary.
|
| Method Summary | |
| public void | addDataDictionaryLocations(List<String> locations)
| | public void | forceCompleteDataDictionaryLoad()
Forces the DD to completely load itself immediately. | | public ControlDefinition | getAttributeControlDefinition(Class businessObjectClass, String attributeName)
| | public ControlDefinition | getAttributeControlDefinition(String entryName, String attributeName)
| | public String | getAttributeDescription(Class businessObjectClass, String attributeName)
| | public String | getAttributeDescription(String entryName, String attributeName)
| | public Mask | getAttributeDisplayMask(Class businessObjectClass, String attributeName)
| | public Mask | getAttributeDisplayMask(String entryName, String attributeName)
| | public String | getAttributeDisplayWorkgroup(Class businessObjectClass, String attributeName)
| | public String | getAttributeDisplayWorkgroup(String entryName, String attributeName)
| | public String | getAttributeErrorLabel(Class businessObjectClass, String attributeName)
| | public String | getAttributeErrorLabel(String entryName, String attributeName)
| | public BigDecimal | getAttributeExclusiveMin(String entryName, String attributeName)
| | public Boolean | getAttributeForceUppercase(Class businessObjectClass, String attributeName)
| | public Boolean | getAttributeForceUppercase(String entryName, String attributeName)
| | public Class | getAttributeFormatter(Class businessObjectClass, String attributeName)
| | public Class | getAttributeFormatter(String entryName, String attributeName)
| | public BigDecimal | getAttributeInclusiveMax(String entryName, String attributeName)
| | public String | getAttributeLabel(Class businessObjectClass, String attributeName)
the label to be used for displaying the attribute. | | public String | getAttributeLabel(String entryName, String attributeName)
the label to be used for displaying the attribute. | | public Integer | getAttributeMaxLength(Class businessObjectClass, String attributeName)
the max length defined for the given attribute name. | | public Integer | getAttributeMaxLength(String entryName, String attributeName)
the max length defined for the given attribute name. | | public String | getAttributeShortLabel(Class businessObjectClass, String attributeName)
the short label to be used for displaying the attribute. | | public String | getAttributeShortLabel(String entryName, String attributeName)
the short label to be used for displaying the attribute. | | public Integer | getAttributeSize(Class businessObjectClass, String attributeName)
| | public Integer | getAttributeSize(String entryName, String attributeName)
| | public String | getAttributeSummary(Class businessObjectClass, String attributeName)
| | public String | getAttributeSummary(String entryName, String attributeName)
| | public Pattern | getAttributeValidatingExpression(Class businessObjectClass, String attributeName)
the regular expression defined to validate the given attribute name. | | public Pattern | getAttributeValidatingExpression(String entryName, String attributeName)
the regular expression defined to validate the given attribute name. | | public Class | getAttributeValuesFinderClass(Class businessObjectClass, String attributeName)
| | public Class | getAttributeValuesFinderClass(String entryName, String attributeName)
| | public String | getCollectionDescription(Class businessObjectClass, String collectionName)
| | public String | getCollectionDescription(String entryName, String collectionName)
| | public String | getCollectionElementLabel(String entryName, String collectionName, Class businessObjectClass)
the element label to be used for displaying the collection. | | public String | getCollectionLabel(Class businessObjectClass, String collectionName)
the label to be used for displaying the collection. | | public String | getCollectionLabel(String entryName, String collectionName)
the label to be used for displaying the collection. | | public String | getCollectionShortLabel(Class businessObjectClass, String collectionName)
the short label to be used for displaying the collection. | | public String | getCollectionShortLabel(String entryName, String collectionName)
the short label to be used for displaying the collection. | | public String | getCollectionSummary(Class businessObjectClass, String collectionName)
| | public String | getCollectionSummary(String entryName, String collectionName)
| | public DataDictionary | getDataDictionary()
| | public Map | getDataDictionaryMap()
Adds entries to the data dictionary. | | public Class | getDocumentClassByTypeName(String documentTypeName)
Returns the document class declared in the dd for the given document type name. | | public String | getDocumentLabelByClass(Class documentOrBusinessObjectClass)
| | public String | getDocumentLabelByTypeName(String documentTypeName)
| | public String | getDocumentTypeCodeByTypeName(String documentTypeName)
Returns the document type code declared in the dd for the given document type name. | | public String | getDocumentTypeNameByClass(Class documentClass)
Returns the document type name declared in the dd for the given document class. | | public Class | getPreRulesCheckClass(String docTypeName)
| | public Map<String, String> | getRelationshipAttributeMap(String entryName, String relationshipName)
| | public List<String> | getRelationshipEntriesForSourceAttribute(String entryName, String sourceAttributeName)
| | public List<String> | getRelationshipEntriesForTargetAttribute(String entryName, String targetAttributeName)
| | public List<String> | getRelationshipNames(String entryName)
| | public List<String> | getRelationshipSourceAttributes(String entryName, String relationshipName)
| | public Class | getRelationshipSourceClass(String entryName, String relationshipName)
| | public List<String> | getRelationshipTargetAttributes(String entryName, String relationshipName)
| | public Class | getRelationshipTargetClass(String entryName, String relationshipName)
| | public boolean | hasRelationship(String entryName, String relationshipName)
| | public Boolean | isAttributeDefined(Class businessObjectClass, String attributeName)
| | public Boolean | isAttributeDefined(String entryName, String attributeName)
| | public Boolean | isAttributeRequired(Class businessObjectClass, String attributeName)
| | public Boolean | isAttributeRequired(String entryName, String attributeName)
| | public void | setBaselinePackages(List baselinePackages)
Sequentially adds each package named (as a String) in the given List as a source of unique entries to the DataDictionary
being constructed. |
| addDataDictionaryLocations | | public void addDataDictionaryLocations(List<String> locations)(Code) | | |
| forceCompleteDataDictionaryLoad | | public void forceCompleteDataDictionaryLoad()(Code) | | Forces the DD to completely load itself immediately. Used by application components which require
a complete list of all BO and document components.
|
| getAttributeControlDefinition | | public ControlDefinition getAttributeControlDefinition(Class businessObjectClass, String attributeName)(Code) | | the html control type used to render the field
|
| getAttributeControlDefinition | | public ControlDefinition getAttributeControlDefinition(String entryName, String attributeName)(Code) | | the html control type used to render the field
|
| getAttributeDescription | | public String getAttributeDescription(Class businessObjectClass, String attributeName)(Code) | | detailed help text for attribute
|
| getAttributeDescription | | public String getAttributeDescription(String entryName, String attributeName)(Code) | | detailed help text for attribute
|
| getAttributeDisplayMask | | public Mask getAttributeDisplayMask(Class businessObjectClass, String attributeName)(Code) | | the Mask object defined for masking the attribute's data value
|
| getAttributeDisplayMask | | public Mask getAttributeDisplayMask(String entryName, String attributeName)(Code) | | the Mask object defined for masking the attribute's data value
|
| getAttributeDisplayWorkgroup | | public String getAttributeDisplayWorkgroup(Class businessObjectClass, String attributeName)(Code) | | the workgroup name (if specified) who has permission to view values for the field
|
| getAttributeDisplayWorkgroup | | public String getAttributeDisplayWorkgroup(String entryName, String attributeName)(Code) | | the workgroup name (if specified) who has permission to view values for the field
|
| getAttributeErrorLabel | | public String getAttributeErrorLabel(Class businessObjectClass, String attributeName)(Code) | | the "label (short label)" used for displaying error messages
|
| getAttributeErrorLabel | | public String getAttributeErrorLabel(String entryName, String attributeName)(Code) | | the "label (short label)" used for displaying error messages
|
| getAttributeExclusiveMin | | public BigDecimal getAttributeExclusiveMin(String entryName, String attributeName)(Code) | |
Parameters:
entryName -
Parameters:
attributeName - the exclusive minimum for the specified attribute, or null if none. |
| getAttributeForceUppercase | | public Boolean getAttributeForceUppercase(Class businessObjectClass, String attributeName)(Code) | | indicates whether or not to force input text into uppercase
|
| getAttributeForceUppercase | | public Boolean getAttributeForceUppercase(String entryName, String attributeName)(Code) | | indicates whether or not to force input text into uppercase
|
| getAttributeFormatter | | public Class getAttributeFormatter(Class businessObjectClass, String attributeName)(Code) | | the formatter class used to format the attribute value
|
| getAttributeFormatter | | public Class getAttributeFormatter(String entryName, String attributeName)(Code) | | the formatter class used to format the attribute value
|
| getAttributeInclusiveMax | | public BigDecimal getAttributeInclusiveMax(String entryName, String attributeName)(Code) | |
Parameters:
entryName -
Parameters:
attributeName - the inclusive maximum for the specified attribute, or null if none. |
| getAttributeLabel | | public String getAttributeLabel(Class businessObjectClass, String attributeName)(Code) | | the label to be used for displaying the attribute.
|
| getAttributeLabel | | public String getAttributeLabel(String entryName, String attributeName)(Code) | | the label to be used for displaying the attribute.
|
| getAttributeMaxLength | | public Integer getAttributeMaxLength(Class businessObjectClass, String attributeName)(Code) | | the max length defined for the given attribute name.
|
| getAttributeMaxLength | | public Integer getAttributeMaxLength(String entryName, String attributeName)(Code) | | the max length defined for the given attribute name.
|
| getAttributeShortLabel | | public String getAttributeShortLabel(Class businessObjectClass, String attributeName)(Code) | | the short label to be used for displaying the attribute.
|
| getAttributeShortLabel | | public String getAttributeShortLabel(String entryName, String attributeName)(Code) | | the short label to be used for displaying the attribute.
|
| getAttributeSize | | public Integer getAttributeSize(Class businessObjectClass, String attributeName)(Code) | | the display size of the field if text control
|
| getAttributeSize | | public Integer getAttributeSize(String entryName, String attributeName)(Code) | | the display size of the field if text control
|
| getAttributeSummary | | public String getAttributeSummary(Class businessObjectClass, String attributeName)(Code) | | short help text for attribute
|
| getAttributeSummary | | public String getAttributeSummary(String entryName, String attributeName)(Code) | | short help text for attribute
|
| getAttributeValidatingExpression | | public Pattern getAttributeValidatingExpression(Class businessObjectClass, String attributeName)(Code) | | the regular expression defined to validate the given attribute name.
|
| getAttributeValidatingExpression | | public Pattern getAttributeValidatingExpression(String entryName, String attributeName)(Code) | | the regular expression defined to validate the given attribute name.
|
| getAttributeValuesFinderClass | | public Class getAttributeValuesFinderClass(Class businessObjectClass, String attributeName)(Code) | | the Class that returns a values list for this attribute
|
| getAttributeValuesFinderClass | | public Class getAttributeValuesFinderClass(String entryName, String attributeName)(Code) | | the Class that returns a values list for this attribute
|
| getCollectionDescription | | public String getCollectionDescription(Class businessObjectClass, String collectionName)(Code) | | detailed help text for collection
|
| getCollectionDescription | | public String getCollectionDescription(String entryName, String collectionName)(Code) | | detailed help text for collection
|
| getCollectionElementLabel | | public String getCollectionElementLabel(String entryName, String collectionName, Class businessObjectClass)(Code) | | the element label to be used for displaying the collection.
|
| getCollectionLabel | | public String getCollectionLabel(Class businessObjectClass, String collectionName)(Code) | | the label to be used for displaying the collection.
|
| getCollectionLabel | | public String getCollectionLabel(String entryName, String collectionName)(Code) | | the label to be used for displaying the collection.
|
| getCollectionShortLabel | | public String getCollectionShortLabel(Class businessObjectClass, String collectionName)(Code) | | the short label to be used for displaying the collection.
|
| getCollectionShortLabel | | public String getCollectionShortLabel(String entryName, String collectionName)(Code) | | the short label to be used for displaying the collection.
|
| getCollectionSummary | | public String getCollectionSummary(Class businessObjectClass, String collectionName)(Code) | | short help text for collection
|
| getCollectionSummary | | public String getCollectionSummary(String entryName, String collectionName)(Code) | | short help text for collection
|
| getDataDictionaryMap | | public Map getDataDictionaryMap()(Code) | | Adds entries to the data dictionary.
|
| getDocumentClassByTypeName | | public Class getDocumentClassByTypeName(String documentTypeName)(Code) | | Returns the document class declared in the dd for the given document type name.
Parameters:
documentTypeName - document Class |
| getDocumentLabelByClass | | public String getDocumentLabelByClass(Class documentOrBusinessObjectClass)(Code) | | This method returns the user friendly label based on the document or business object class
Parameters:
documentTypeName - label |
| getDocumentLabelByTypeName | | public String getDocumentLabelByTypeName(String documentTypeName)(Code) | | This method returns the user friendly label based on the workflow doc type name
Parameters:
documentTypeName - label |
| getDocumentTypeCodeByTypeName | | public String getDocumentTypeCodeByTypeName(String documentTypeName)(Code) | | Returns the document type code declared in the dd for the given document type name.
Parameters:
documentTypeName - documentTypeCode |
| getDocumentTypeNameByClass | | public String getDocumentTypeNameByClass(Class documentClass)(Code) | | Returns the document type name declared in the dd for the given document class.
Parameters:
documentClass - documentTypeName |
| getPreRulesCheckClass | | public Class getPreRulesCheckClass(String docTypeName)(Code) | |
Parameters:
document - preRulesCheckClass associated with the given document's type |
| getRelationshipAttributeMap | | public Map<String, String> getRelationshipAttributeMap(String entryName, String relationshipName)(Code) | | returns a Map that specifies the attributes of the relationship
Parameters:
entryName - - Name of the Business Object entry
Parameters:
relationshipName - - Name of the relationship Map - Target field as key, source field as value |
| getRelationshipEntriesForSourceAttribute | | public List<String> getRelationshipEntriesForSourceAttribute(String entryName, String sourceAttributeName)(Code) | | returns a list of names for all entries whose source parameter matches the parameter
Parameters:
entryName - Name of the Business Object entry
Parameters:
sourceAttributeName - name of the source attribute the names of all entries that use the sourceAttributeName as a primitive attribute |
| getRelationshipEntriesForTargetAttribute | | public List<String> getRelationshipEntriesForTargetAttribute(String entryName, String targetAttributeName)(Code) | | returns a list of names for all entries whose source parameter matches the parameter
Parameters:
entryName - Name of the Business Object entry
Parameters:
targetAttributeName - name of the target attribute the names of all entries that use the targetAttributeName as a primitive attribute |
| getRelationshipNames | | public List<String> getRelationshipNames(String entryName)(Code) | | Returns all of the relationships defined for a BO in the DD
Parameters:
name - of the BO entry a list of all DD defined mappings |
| getRelationshipSourceAttributes | | public List<String> getRelationshipSourceAttributes(String entryName, String relationshipName)(Code) | |
Parameters:
entryName -
Parameters:
relationshipName - List of source attributeNames for the given relationship, or null if there is no relationship with that name |
| getRelationshipSourceClass | | public Class getRelationshipSourceClass(String entryName, String relationshipName)(Code) | |
Parameters:
entryName -
Parameters:
relationshipName - source Class for the given relationship, or null if there is no relationship with that name |
| getRelationshipTargetAttributes | | public List<String> getRelationshipTargetAttributes(String entryName, String relationshipName)(Code) | |
Parameters:
entryName -
Parameters:
relationshipName - List of target attributeNames for the given relationship, or null if there is no relationship with that name |
| getRelationshipTargetClass | | public Class getRelationshipTargetClass(String entryName, String relationshipName)(Code) | |
Parameters:
entryName -
Parameters:
relationshipName - target Class for the given relationship, or null if there is no relationship with that name |
| hasRelationship | | public boolean hasRelationship(String entryName, String relationshipName)(Code) | | Determines whether there is a relationship defined for the given entry with the given name
Parameters:
entryName - name of the BO entry
Parameters:
relationshipName - name of the relationship for the entry true iff there is a relationship with the given name defined for the BO entry in the DD |
| isAttributeDefined | | public Boolean isAttributeDefined(Class businessObjectClass, String attributeName)(Code) | | indicates whether or not the named attribute is defined in the business object xml
|
| isAttributeDefined | | public Boolean isAttributeDefined(String entryName, String attributeName)(Code) | | indicates whether or not the named attribute is defined in the business object xml
|
| isAttributeRequired | | public Boolean isAttributeRequired(Class businessObjectClass, String attributeName)(Code) | | indicates whether or not the named attribute is required
|
| isAttributeRequired | | public Boolean isAttributeRequired(String entryName, String attributeName)(Code) | | indicates whether or not the named attribute is required
|
| setBaselinePackages | | public void setBaselinePackages(List baselinePackages)(Code) | | Sequentially adds each package named (as a String) in the given List as a source of unique entries to the DataDictionary
being constructed. Duplicate entries among any of the XML files in any of these packages will result in exceptions being
thrown, hence service-initialization failure.
Parameters:
baselinePackages -
throws:
SourceException - if any of the given packages can't be located |
|
|