org.kuali.rice.krad.service.impl
Class DataDictionaryServiceImpl

java.lang.Object
  org.kuali.rice.krad.service.impl.DataDictionaryServiceImpl

All Implemented Interfaces:

DataDictionaryService

Direct Known Subclasses:

DataDictionaryServiceImpl

public class DataDictionaryServiceImpl
extends Object
implements DataDictionaryService

Service implementation for a DataDictionary. It is a thin wrapper around creating, initializing, and returning a DataDictionary. This is the default, Kuali delivered implementation

Author:

Kuali Rice Team (rice.collab@kuali.org)

Constructor Summary

DataDictionaryServiceImpl()
Default constructor.

DataDictionaryServiceImpl(DataDictionary dataDictionary)

Method Summary

void	addDataDictionaryLocations(String namespaceCode, List<String> locations) Sequentially adds each package named (as a String) in the given List as a source of unique entries to the DataDictionary being constructed
boolean	containsDictionaryObject(String id) Indicates whether the data dictionary contains a bean with the given id
Set<InactivationBlockingMetadata>	getAllInactivationBlockingDefinitions(Class inactivationBlockedBusinessObjectClass) Returns all of the inactivation blocks registered for a particular business object
ControlDefinition	getAttributeControlDefinition(Class dataObjectClass, String attributeName) the html control type used to render the field
ControlDefinition	getAttributeControlDefinition(String entryName, String attributeName) the html control type used to render the field
AttributeDefinition	getAttributeDefinition(String entryName, String attributeName) AttributeDefinition associated with the given attributeName within the given entry
String	getAttributeDescription(Class dataObjectClass, String attributeName) detailed help text for attribute
String	getAttributeDescription(String entryName, String attributeName) detailed help text for attribute
String	getAttributeErrorLabel(Class dataObjectClass, String attributeName) the "label (short label)" used for displaying error messages
String	getAttributeErrorLabel(String entryName, String attributeName) the "label (short label)" used for displaying error messages
String	getAttributeExclusiveMin(String entryName, String attributeName)
Boolean	getAttributeForceUppercase(Class dataObjectClass, String attributeName) indicates whether or not to force input text into uppercase
Boolean	getAttributeForceUppercase(String entryName, String attributeName) indicates whether or not to force input text into uppercase
Class<? extends Formatter>	getAttributeFormatter(Class dataObjectClass, String attributeName) the formatter class used to format the attribute value
Class<? extends Formatter>	getAttributeFormatter(String entryName, String attributeName) the formatter class used to format the attribute value
String	getAttributeInclusiveMax(String entryName, String attributeName)
String	getAttributeLabel(Class dataObjectClass, String attributeName) the label to be used for displaying the attribute.
String	getAttributeLabel(String entryName, String attributeName) the label to be used for displaying the attribute.
Integer	getAttributeMaxLength(Class dataObjectClass, String attributeName) the max length defined for the given attribute name.
Integer	getAttributeMaxLength(String entryName, String attributeName) the max length defined for the given attribute name.
Integer	getAttributeMinLength(String entryName, String attributeName) the min length defined for the given attribute name.
AttributeSecurity	getAttributeSecurity(String entryName, String attributeName) the AttributeSecurity object defined for the attribute's data value
String	getAttributeShortLabel(Class dataObjectClass, String attributeName) the short label to be used for displaying the attribute.
String	getAttributeShortLabel(String entryName, String attributeName) the short label to be used for displaying the attribute.
Integer	getAttributeSize(Class dataObjectClass, String attributeName) the display size of the field if text control
Integer	getAttributeSize(String entryName, String attributeName) the display size of the field if text control
String	getAttributeSummary(Class dataObjectClass, String attributeName) short help text for attribute
String	getAttributeSummary(String entryName, String attributeName) short help text for attribute
String	getAttributeValidatingErrorMessageKey(String entryName, String attributeName)
String[]	getAttributeValidatingErrorMessageParameters(String entryName, String attributeName)
Pattern	getAttributeValidatingExpression(Class dataObjectClass, String attributeName) the regular expression defined to validate the given attribute name.
Pattern	getAttributeValidatingExpression(String entryName, String attributeName) the regular expression defined to validate the given attribute name.
Class	getAttributeValuesFinderClass(Class dataObjectClass, String attributeName) the Class that returns a values list for this attribute
Class<? extends KeyValuesFinder>	getAttributeValuesFinderClass(String entryName, String attributeName) the Class that returns a values list for this attribute
String	getCollectionDescription(Class dataObjectClass, String collectionName) detailed help text for collection
String	getCollectionDescription(String entryName, String collectionName) detailed help text for collection
String	getCollectionElementLabel(String entryName, String collectionName, Class dataObjectClass) the element label to be used for displaying the collection.
String	getCollectionLabel(Class dataObjectClass, String collectionName) the label to be used for displaying the collection.
String	getCollectionLabel(String entryName, String collectionName) the label to be used for displaying the collection.
String	getCollectionShortLabel(Class dataObjectClass, String collectionName) the short label to be used for displaying the collection.
String	getCollectionShortLabel(String entryName, String collectionName) the short label to be used for displaying the collection.
String	getCollectionSummary(Class dataObjectClass, String collectionName) short help text for collection
String	getCollectionSummary(String entryName, String collectionName) short help text for collection
DataDictionary	getDataDictionary()
Object	getDictionaryObject(String id) Returns an object from the dictionary by its spring bean name or id
Class<? extends Document>	getDocumentClassByTypeName(String documentTypeName) Returns the document class declared in the dd for the given document type name.
String	getDocumentLabelByClass(Class documentOrBusinessObjectClass) This method returns the user friendly label based on the document or business object class
String	getDocumentLabelByTypeName(String documentTypeName) This method returns the user friendly label based on the workflow doc type name
String	getDocumentTypeNameByClass(Class documentClass) Returns the document type name declared in the dd for the given document class.
DocumentTypeService	getDocumentTypeService()
List<String>	getGroupByAttributesForEffectiveDating(Class dataObjectClass) Returns the list of attributes that should be used for grouping when determining the current status of a business object that implements InactivateableFromTo
ConfigurationService	getKualiConfigurationService()
KualiModuleService	getKualiModuleService()
Map<String,String>	getRelationshipAttributeMap(String entryName, String relationshipName) returns a Map that specifies the attributes of the relationship
List<String>	getRelationshipEntriesForSourceAttribute(String entryName, String sourceAttributeName) returns a list of names for all entries whose source parameter matches the parameter
List<String>	getRelationshipEntriesForTargetAttribute(String entryName, String targetAttributeName) returns a list of names for all entries whose source parameter matches the parameter
List<String>	getRelationshipNames(String entryName) Returns all of the relationships defined for a BO in the DD
List<String>	getRelationshipSourceAttributes(String entryName, String relationshipName)
Class<? extends BusinessObject>	getRelationshipSourceClass(String entryName, String relationshipName)
List<String>	getRelationshipTargetAttributes(String entryName, String relationshipName)
Class<? extends BusinessObject>	getRelationshipTargetClass(String entryName, String relationshipName)
Class<? extends Document>	getValidDocumentClassByTypeName(String documentTypeName) Returns the document class declared in the dd for the given document type name.
String	getValidDocumentTypeNameByClass(Class documentClass) Returns the document type name declared in the dd for the given document class.
View	getViewById(String viewId) Returns the View entry identified by the given id
View	getViewByTypeIndex(UifConstants.ViewType viewTypeName, Map<String,String> indexKey) Returns View instance identified by the view type name and index
String	getViewIdByTypeIndex(UifConstants.ViewType viewTypeName, Map<String,String> indexKey) Returns the view id for the view that matches the given view type and index
boolean	hasRelationship(String entryName, String relationshipName) Determines whether there is a relationship defined for the given entry with the given name
Boolean	isAttributeDefined(Class dataObjectClass, String attributeName) indicates whether or not the named attribute is defined in the business object xml
Boolean	isAttributeDefined(String entryName, String attributeName) indicates whether or not the named attribute is defined in the business object xml
Boolean	isAttributeRequired(Class dataObjectClass, String attributeName) indicates whether or not the named attribute is required
Boolean	isAttributeRequired(String entryName, String attributeName) indicates whether or not the named attribute is required
void	setAdditionalDictionaryFiles(Map<String,List<String>> additionalDictionaryFiles) Adds additional dictionary files to the data dictionary (files that will not be loaded through one of the module configurations)
void	setKualiConfigurationService(ConfigurationService kualiConfigurationService)
void	setKualiModuleService(KualiModuleService kualiModuleService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataDictionaryServiceImpl

public DataDictionaryServiceImpl()

Default constructor.

DataDictionaryServiceImpl

public DataDictionaryServiceImpl(DataDictionary dataDictionary)

Method Detail

setAdditionalDictionaryFiles

public void setAdditionalDictionaryFiles(Map<String,List<String>> additionalDictionaryFiles)
                                  throws IOException

Description copied from interface: DataDictionaryService

Adds additional dictionary files to the data dictionary (files that will not be loaded through one of the module configurations)

Additional files must be associated with a namespace thus a map is specified with the key giving the namespace the list of files should be associated with

Duplicate entries among any of the XML files in any of these packages will result in exceptions being thrown, hence service-initialization failure

Specified by:

setAdditionalDictionaryFiles in interface DataDictionaryService

Parameters:

additionalDictionaryFiles - map where key is namespace and value is list of dictionary files that should be added to that namespace

Throws:

IOException - if any of the given packages can't be located

See Also:

org.kuali.rice.krad.service.DataDictionaryService#setAdditionalDictionaryFiles( java.util.Map>)

addDataDictionaryLocations

public void addDataDictionaryLocations(String namespaceCode,
                                       List<String> locations)
                                throws IOException

Description copied from interface: DataDictionaryService

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

Specified by:

addDataDictionaryLocations in interface DataDictionaryService

Parameters:

namespaceCode - - namespace the beans loaded from the location should be associated with

locations - - list of locations to add (either classpath entries or file/folder locations)

Throws:

IOException - if any of the given packages can't be located

See Also:

org.kuali.rice.krad.service.DataDictionaryService#addDataDictionaryLocations( java.lang.String, java.util.List)

getDataDictionary

public DataDictionary getDataDictionary()

Specified by:

getDataDictionary in interface DataDictionaryService

Returns:

current DataDictionary

See Also:

DataDictionaryService.getDataDictionary()

getAttributeControlDefinition

public ControlDefinition getAttributeControlDefinition(String entryName,
                                                       String attributeName)

Description copied from interface: DataDictionaryService

the html control type used to render the field

Specified by:

getAttributeControlDefinition in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeControlDefinition(java.lang.String)

getAttributeSize

public Integer getAttributeSize(String entryName,
                                String attributeName)

Description copied from interface: DataDictionaryService

the display size of the field if text control

Specified by:

getAttributeSize in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeSize(java.lang.String)

getAttributeMinLength

public Integer getAttributeMinLength(String entryName,
                                     String attributeName)

Description copied from interface: DataDictionaryService

the min length defined for the given attribute name.

Specified by:

getAttributeMinLength in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeMinLength(java.lang.String)

getAttributeMaxLength

public Integer getAttributeMaxLength(String entryName,
                                     String attributeName)

Description copied from interface: DataDictionaryService

the max length defined for the given attribute name.

Specified by:

getAttributeMaxLength in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeMaxLength(java.lang.String)

getAttributeExclusiveMin

public String getAttributeExclusiveMin(String entryName,
                                       String attributeName)

Specified by:

getAttributeExclusiveMin in interface DataDictionaryService

Returns:

the exclusive minimum for the specified attribute, or null if none.

See Also:

DataDictionaryService.getAttributeExclusiveMin(java.lang.String, java.lang.String)

getAttributeInclusiveMax

public String getAttributeInclusiveMax(String entryName,
                                       String attributeName)

Specified by:

getAttributeInclusiveMax in interface DataDictionaryService

Returns:

the inclusive maximum for the specified attribute, or null if none.

See Also:

DataDictionaryService.getAttributeInclusiveMax(java.lang.String, java.lang.String)

getAttributeValidatingExpression

public Pattern getAttributeValidatingExpression(String entryName,
                                                String attributeName)

Description copied from interface: DataDictionaryService

the regular expression defined to validate the given attribute name.

Specified by:

getAttributeValidatingExpression in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeValidatingExpression(java.lang.String)

getAttributeLabel

public String getAttributeLabel(String entryName,
                                String attributeName)

Description copied from interface: DataDictionaryService

the label to be used for displaying the attribute.

Specified by:

getAttributeLabel in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeLabel(java.lang.String)

getAttributeShortLabel

public String getAttributeShortLabel(String entryName,
                                     String attributeName)

Description copied from interface: DataDictionaryService

the short label to be used for displaying the attribute.

Specified by:

getAttributeShortLabel in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeShortLabel(java.lang.String)

getAttributeErrorLabel

public String getAttributeErrorLabel(String entryName,
                                     String attributeName)

Description copied from interface: DataDictionaryService

the "label (short label)" used for displaying error messages

Specified by:

getAttributeErrorLabel in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeErrorLabel(java.lang.String)

getAttributeFormatter

public Class<? extends Formatter> getAttributeFormatter(String entryName,
                                                        String attributeName)

Description copied from interface: DataDictionaryService

the formatter class used to format the attribute value

Specified by:

getAttributeFormatter in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeFormatter(java.lang.String)

getAttributeForceUppercase

public Boolean getAttributeForceUppercase(String entryName,
                                          String attributeName)
                                   throws UnknownBusinessClassAttributeException

Description copied from interface: DataDictionaryService

indicates whether or not to force input text into uppercase

Specified by:

getAttributeForceUppercase in interface DataDictionaryService

Throws:

UnknownBusinessClassAttributeException

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeForceUppercase(java.lang.String)

getAttributeSecurity

public AttributeSecurity getAttributeSecurity(String entryName,
                                              String attributeName)

Description copied from interface: DataDictionaryService

the AttributeSecurity object defined for the attribute's data value

Specified by:

getAttributeSecurity in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeDisplayMask(java.lang.String, java.lang.String)

getAttributeSummary

public String getAttributeSummary(String entryName,
                                  String attributeName)

Description copied from interface: DataDictionaryService

short help text for attribute

Specified by:

getAttributeSummary in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeSummary(java.lang.String)

getAttributeDescription

public String getAttributeDescription(String entryName,
                                      String attributeName)

Description copied from interface: DataDictionaryService

detailed help text for attribute

Specified by:

getAttributeDescription in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeDescription(java.lang.String)

isAttributeRequired

public Boolean isAttributeRequired(String entryName,
                                   String attributeName)

Description copied from interface: DataDictionaryService

indicates whether or not the named attribute is required

Specified by:

isAttributeRequired in interface DataDictionaryService

See Also:

DataDictionaryService.isAttributeRequired(java.lang.Class, java.lang.String)

isAttributeDefined

public Boolean isAttributeDefined(String entryName,
                                  String attributeName)

Description copied from interface: DataDictionaryService

indicates whether or not the named attribute is defined in the business object xml

Specified by:

isAttributeDefined in interface DataDictionaryService

See Also:

DataDictionaryService.isAttributeDefined(java.lang.Class, java.lang.String)

getAttributeValuesFinderClass

public Class<? extends KeyValuesFinder> getAttributeValuesFinderClass(String entryName,
                                                                      String attributeName)

Description copied from interface: DataDictionaryService

the Class that returns a values list for this attribute

Specified by:

getAttributeValuesFinderClass in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getAttributeValuesScopeId(java.lang.Class, java.lang.String)

getCollectionLabel

public String getCollectionLabel(String entryName,
                                 String collectionName)

Description copied from interface: DataDictionaryService

the label to be used for displaying the collection.

Specified by:

getCollectionLabel in interface DataDictionaryService

See Also:

DataDictionaryService.getCollectionLabel(java.lang.Class, java.lang.String)

getCollectionShortLabel

public String getCollectionShortLabel(String entryName,
                                      String collectionName)

Description copied from interface: DataDictionaryService

the short label to be used for displaying the collection.

Specified by:

getCollectionShortLabel in interface DataDictionaryService

See Also:

DataDictionaryService.getCollectionShortLabel(java.lang.Class, java.lang.String)

getCollectionElementLabel

public String getCollectionElementLabel(String entryName,
                                        String collectionName,
                                        Class dataObjectClass)

Description copied from interface: DataDictionaryService

the element label to be used for displaying the collection.

Specified by:

getCollectionElementLabel in interface DataDictionaryService

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getCollectionElementLabel(java.lang.Class, java.lang.String)

getCollectionSummary

public String getCollectionSummary(String entryName,
                                   String collectionName)

Description copied from interface: DataDictionaryService

short help text for collection

Specified by:

getCollectionSummary in interface DataDictionaryService

See Also:

DataDictionaryService.getCollectionSummary(java.lang.Class, java.lang.String)

getCollectionDescription

public String getCollectionDescription(String entryName,
                                       String collectionName)

Description copied from interface: DataDictionaryService

detailed help text for collection

Specified by:

getCollectionDescription in interface DataDictionaryService

See Also:

DataDictionaryService.getCollectionDescription(java.lang.Class, java.lang.String)

getRelationshipSourceClass

public Class<? extends BusinessObject> getRelationshipSourceClass(String entryName,
                                                                  String relationshipName)

Specified by:

getRelationshipSourceClass in interface DataDictionaryService

Returns:

source Class for the given relationship, or null if there is no relationship with that name

getRelationshipTargetClass

public Class<? extends BusinessObject> getRelationshipTargetClass(String entryName,
                                                                  String relationshipName)

Specified by:

getRelationshipTargetClass in interface DataDictionaryService

Returns:

target Class for the given relationship, or null if there is no relationship with that name

getRelationshipSourceAttributes

public List<String> getRelationshipSourceAttributes(String entryName,
                                                    String relationshipName)

Specified by:

getRelationshipSourceAttributes in interface DataDictionaryService

Returns:

List of source attributeNames for the given relationship, or null if there is no relationship with that name

getRelationshipTargetAttributes

public List<String> getRelationshipTargetAttributes(String entryName,
                                                    String relationshipName)

Specified by:

getRelationshipTargetAttributes in interface DataDictionaryService

Returns:

List of target attributeNames for the given relationship, or null if there is no relationship with that name

getRelationshipEntriesForSourceAttribute

public List<String> getRelationshipEntriesForSourceAttribute(String entryName,
                                                             String sourceAttributeName)

Description copied from interface: DataDictionaryService

returns a list of names for all entries whose source parameter matches the parameter

Specified by:

getRelationshipEntriesForSourceAttribute in interface DataDictionaryService

Parameters:

entryName - Name of the Business Object entry

sourceAttributeName - name of the source attribute

Returns:

the names of all entries that use the sourceAttributeName as a primitive attribute

getRelationshipEntriesForTargetAttribute

public List<String> getRelationshipEntriesForTargetAttribute(String entryName,
                                                             String targetAttributeName)

Description copied from interface: DataDictionaryService

returns a list of names for all entries whose source parameter matches the parameter

Specified by:

getRelationshipEntriesForTargetAttribute in interface DataDictionaryService

Parameters:

entryName - Name of the Business Object entry

targetAttributeName - name of the target attribute

Returns:

the names of all entries that use the targetAttributeName as a primitive attribute

getAttributeDefinition

public AttributeDefinition getAttributeDefinition(String entryName,
                                                  String attributeName)

Description copied from interface: DataDictionaryService

AttributeDefinition associated with the given attributeName within the given entry

Specified by:

getAttributeDefinition in interface DataDictionaryService

Parameters:

entryName - - the qualified object name e.g. edu.sampleu.demo.kitchensink.TimeInfo

attributeName - - an attribute name e.g. startTimeAmPm

Returns:

AttributeDefinition for the given dataObjectClass and attribute name, or null if there is none

Throws:

IllegalArgumentException - if the given Class is null or is not a BusinessObject class

getRelationshipAttributeMap

public Map<String,String> getRelationshipAttributeMap(String entryName,
                                                      String relationshipName)

Description copied from interface: DataDictionaryService

returns a Map that specifies the attributes of the relationship

Specified by:

getRelationshipAttributeMap in interface DataDictionaryService

Parameters:

entryName - - Name of the Business Object entry

relationshipName - - Name of the relationship

Returns:

Map - Target field as key, source field as value

See Also:

DataDictionaryService.getRelationshipAttributeMap(java.lang.String, java.lang.String)

hasRelationship

public boolean hasRelationship(String entryName,
                               String relationshipName)

Description copied from interface: DataDictionaryService

Determines whether there is a relationship defined for the given entry with the given name

Specified by:

hasRelationship in interface DataDictionaryService

Parameters:

entryName - name of the BO entry

relationshipName - name of the relationship for the entry

Returns:

true iff there is a relationship with the given name defined for the BO entry in the DD

getRelationshipNames

public List<String> getRelationshipNames(String entryName)

Description copied from interface: DataDictionaryService

Returns all of the relationships defined for a BO in the DD

Specified by:

getRelationshipNames in interface DataDictionaryService

Parameters:

entryName - of the BO entry

Returns:

a list of all DD defined mappings

getAttributeControlDefinition

public ControlDefinition getAttributeControlDefinition(Class dataObjectClass,
                                                       String attributeName)

Description copied from interface: DataDictionaryService

the html control type used to render the field

Specified by:

getAttributeControlDefinition in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeControlDefinition(java.lang.String, java.lang.String)

getAttributeDescription

public String getAttributeDescription(Class dataObjectClass,
                                      String attributeName)

Description copied from interface: DataDictionaryService

detailed help text for attribute

Specified by:

getAttributeDescription in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeDescription(java.lang.String, java.lang.String)

getAttributeForceUppercase

public Boolean getAttributeForceUppercase(Class dataObjectClass,
                                          String attributeName)

Description copied from interface: DataDictionaryService

indicates whether or not to force input text into uppercase

Specified by:

getAttributeForceUppercase in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeForceUppercase(java.lang.String, java.lang.String)

getAttributeFormatter

public Class<? extends Formatter> getAttributeFormatter(Class dataObjectClass,
                                                        String attributeName)

Description copied from interface: DataDictionaryService

the formatter class used to format the attribute value

Specified by:

getAttributeFormatter in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeFormatter(java.lang.String, java.lang.String)

getAttributeLabel

public String getAttributeLabel(Class dataObjectClass,
                                String attributeName)

Description copied from interface: DataDictionaryService

the label to be used for displaying the attribute.

Specified by:

getAttributeLabel in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeLabel(java.lang.String, java.lang.String)

getAttributeMaxLength

public Integer getAttributeMaxLength(Class dataObjectClass,
                                     String attributeName)

Description copied from interface: DataDictionaryService

the max length defined for the given attribute name.

Specified by:

getAttributeMaxLength in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeMaxLength(java.lang.String, java.lang.String)

getAttributeShortLabel

public String getAttributeShortLabel(Class dataObjectClass,
                                     String attributeName)

Description copied from interface: DataDictionaryService

the short label to be used for displaying the attribute.

Specified by:

getAttributeShortLabel in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeShortLabel(java.lang.String, java.lang.String)

getAttributeErrorLabel

public String getAttributeErrorLabel(Class dataObjectClass,
                                     String attributeName)

Description copied from interface: DataDictionaryService

the "label (short label)" used for displaying error messages

Specified by:

getAttributeErrorLabel in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeErrorLabel(java.lang.String, java.lang.String)

getAttributeSize

public Integer getAttributeSize(Class dataObjectClass,
                                String attributeName)

Description copied from interface: DataDictionaryService

the display size of the field if text control

Specified by:

getAttributeSize in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeSize(java.lang.String, java.lang.String)

getAttributeSummary

public String getAttributeSummary(Class dataObjectClass,
                                  String attributeName)

Description copied from interface: DataDictionaryService

short help text for attribute

Specified by:

getAttributeSummary in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeSummary(java.lang.String, java.lang.String)

getAttributeValidatingExpression

public Pattern getAttributeValidatingExpression(Class dataObjectClass,
                                                String attributeName)

Description copied from interface: DataDictionaryService

the regular expression defined to validate the given attribute name.

Specified by:

getAttributeValidatingExpression in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeValidatingExpression(java.lang.String, java.lang.String)

getAttributeValuesFinderClass

public Class getAttributeValuesFinderClass(Class dataObjectClass,
                                           String attributeName)

Description copied from interface: DataDictionaryService

the Class that returns a values list for this attribute

Specified by:

getAttributeValuesFinderClass in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeValuesFinderClass(java.lang.String, java.lang.String)

getAttributeValidatingErrorMessageKey

public String getAttributeValidatingErrorMessageKey(String entryName,
                                                    String attributeName)

Specified by:

getAttributeValidatingErrorMessageKey in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeValidatingErrorMessageKey(java.lang.String, java.lang.String)

getAttributeValidatingErrorMessageParameters

public String[] getAttributeValidatingErrorMessageParameters(String entryName,
                                                             String attributeName)

Specified by:

getAttributeValidatingErrorMessageParameters in interface DataDictionaryService

See Also:

DataDictionaryService.getAttributeValidatingErrorMessageParameters(java.lang.String, java.lang.String)

getCollectionDescription

public String getCollectionDescription(Class dataObjectClass,
                                       String collectionName)

Description copied from interface: DataDictionaryService

detailed help text for collection

Specified by:

getCollectionDescription in interface DataDictionaryService

See Also:

DataDictionaryService.getCollectionDescription(java.lang.String, java.lang.String)

getCollectionLabel

public String getCollectionLabel(Class dataObjectClass,
                                 String collectionName)

Description copied from interface: DataDictionaryService

the label to be used for displaying the collection.

Specified by:

getCollectionLabel in interface DataDictionaryService

See Also:

DataDictionaryService.getCollectionLabel(java.lang.String, java.lang.String)

getCollectionShortLabel

public String getCollectionShortLabel(Class dataObjectClass,
                                      String collectionName)

Description copied from interface: DataDictionaryService

the short label to be used for displaying the collection.

Specified by:

getCollectionShortLabel in interface DataDictionaryService

See Also:

DataDictionaryService.getCollectionShortLabel(java.lang.String, java.lang.String)

getCollectionSummary

public String getCollectionSummary(Class dataObjectClass,
                                   String collectionName)

Description copied from interface: DataDictionaryService

short help text for collection

Specified by:

getCollectionSummary in interface DataDictionaryService

See Also:

DataDictionaryService.getCollectionSummary(java.lang.String, java.lang.String)

isAttributeDefined

public Boolean isAttributeDefined(Class dataObjectClass,
                                  String attributeName)

Description copied from interface: DataDictionaryService

indicates whether or not the named attribute is defined in the business object xml

Specified by:

isAttributeDefined in interface DataDictionaryService

See Also:

DataDictionaryService.isAttributeDefined(java.lang.String, java.lang.String)

isAttributeRequired

public Boolean isAttributeRequired(Class dataObjectClass,
                                   String attributeName)

Description copied from interface: DataDictionaryService

indicates whether or not the named attribute is required

Specified by:

isAttributeRequired in interface DataDictionaryService

See Also:

DataDictionaryService.isAttributeRequired(java.lang.String, java.lang.String)

getDocumentLabelByClass

public String getDocumentLabelByClass(Class documentOrBusinessObjectClass)

Description copied from interface: DataDictionaryService

This method returns the user friendly label based on the document or business object class

Specified by:

getDocumentLabelByClass in interface DataDictionaryService

Returns:

label

See Also:

DataDictionaryService.getDocumentLabelByClass(java.lang.Class)

getDocumentLabelByTypeName

public String getDocumentLabelByTypeName(String documentTypeName)

Description copied from interface: DataDictionaryService

This method returns the user friendly label based on the workflow doc type name

Specified by:

getDocumentLabelByTypeName in interface DataDictionaryService

Returns:

label

See Also:

DataDictionaryService.getDocumentLabelByTypeName(java.lang.String)

getDocumentTypeNameByClass

public String getDocumentTypeNameByClass(Class documentClass)

Description copied from interface: DataDictionaryService

Returns the document type name declared in the dd for the given document class. If no valid document type is found 'null' is returned.

Specified by:

getDocumentTypeNameByClass in interface DataDictionaryService

Returns:

documentTypeName

See Also:

DataDictionaryService.getDocumentTypeNameByClass(java.lang.Class)

getValidDocumentTypeNameByClass

public String getValidDocumentTypeNameByClass(Class documentClass)

Description copied from interface: DataDictionaryService

Returns the document type name declared in the dd for the given document class. If no valid document type is found an UnknownDocumentTypeException is thrown.

Specified by:

getValidDocumentTypeNameByClass in interface DataDictionaryService

Returns:

documentTypeName

See Also:

DataDictionaryService.getValidDocumentTypeNameByClass(java.lang.Class)

getDocumentClassByTypeName

public Class<? extends Document> getDocumentClassByTypeName(String documentTypeName)

Description copied from interface: DataDictionaryService

Returns the document class declared in the dd for the given document type name. If no document entry is found with given document type name, 'null' will be returned.

Specified by:

getDocumentClassByTypeName in interface DataDictionaryService

Returns:

document Class

See Also:

DataDictionaryService.getDocumentClassByTypeName(java.lang.String)

getValidDocumentClassByTypeName

public Class<? extends Document> getValidDocumentClassByTypeName(String documentTypeName)

Description copied from interface: DataDictionaryService

Returns the document class declared in the dd for the given document type name. If no document entry is found with given document type name, and UnknownDocumentTypeException will be thrown.

Specified by:

getValidDocumentClassByTypeName in interface DataDictionaryService

Returns:

document Class

See Also:

DataDictionaryService.getValidDocumentClassByTypeName(java.lang.String)

getViewById

public View getViewById(String viewId)

Description copied from interface: DataDictionaryService

Returns the View entry identified by the given id

Specified by:

getViewById in interface DataDictionaryService

Parameters:

viewId - - unique id for view

Returns:

View instance associated with the id

See Also:

DataDictionaryService.getViewById(java.lang.String)

getDictionaryObject

public Object getDictionaryObject(String id)

Description copied from interface: DataDictionaryService

Returns an object from the dictionary by its spring bean name or id

Specified by:

getDictionaryObject in interface DataDictionaryService

Parameters:

id - - id or name for the bean definition

Returns:

Object object instance created or the singleton being maintained

See Also:

DataDictionaryService.getDictionaryObject(java.lang.String)

containsDictionaryObject

public boolean containsDictionaryObject(String id)

Description copied from interface: DataDictionaryService

Indicates whether the data dictionary contains a bean with the given id

Specified by:

containsDictionaryObject in interface DataDictionaryService

Parameters:

id - - id of the bean to check for

Returns:

boolean true if dictionary contains bean, false otherwise

See Also:

DataDictionaryService.containsDictionaryObject(java.lang.String)

getViewByTypeIndex

public View getViewByTypeIndex(UifConstants.ViewType viewTypeName,
                               Map<String,String> indexKey)

Description copied from interface: DataDictionaryService

Returns View instance identified by the view type name and index

Specified by:

getViewByTypeIndex in interface DataDictionaryService

Parameters:

viewTypeName - - type name for the view

indexKey - - Map of index key parameters, these are the parameters the indexer used to index the view initially and needs to identify an unique view instance

Returns:

View instance that matches the given index

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getViewByTypeIndex(java.lang.String, java.util.Map)

getViewIdByTypeIndex

public String getViewIdByTypeIndex(UifConstants.ViewType viewTypeName,
                                   Map<String,String> indexKey)

Description copied from interface: DataDictionaryService

Returns the view id for the view that matches the given view type and index

Specified by:

getViewIdByTypeIndex in interface DataDictionaryService

Parameters:

viewTypeName - type name for the view

indexKey - Map of index key parameters, these are the parameters the indexer used to index the view initially and needs to identify an unique view instance

Returns:

id for the view that matches the view type and index or null if a match is not found

See Also:

org.kuali.rice.krad.service.DataDictionaryService#getViewIdByTypeIndex(org.kuali.rice.krad.uif.UifConstants.ViewType, java.util.Map)

getGroupByAttributesForEffectiveDating

public List<String> getGroupByAttributesForEffectiveDating(Class dataObjectClass)

Description copied from interface: DataDictionaryService

Returns the list of attributes that should be used for grouping when determining the current status of a business object that implements InactivateableFromTo

Specified by:

getGroupByAttributesForEffectiveDating in interface DataDictionaryService

Parameters:

dataObjectClass - - business object class to get configured list for

Returns:

List of string attribute names that gives the group by list

See Also:

DataDictionaryService.getGroupByAttributesForEffectiveDating(java.lang.Class)

getAllInactivationBlockingDefinitions

public Set<InactivationBlockingMetadata> getAllInactivationBlockingDefinitions(Class inactivationBlockedBusinessObjectClass)

Returns all of the inactivation blocks registered for a particular business object

Specified by:

getAllInactivationBlockingDefinitions in interface DataDictionaryService

Returns:

a set of all registered inactivation blocks for a particular business object

See Also:

DataDictionaryService.getAllInactivationBlockingDefinitions(java.lang.Class)

getDocumentTypeService

public DocumentTypeService getDocumentTypeService()

setKualiConfigurationService

public void setKualiConfigurationService(ConfigurationService kualiConfigurationService)

getKualiConfigurationService

public ConfigurationService getKualiConfigurationService()

getKualiModuleService

public KualiModuleService getKualiModuleService()

setKualiModuleService

public void setKualiModuleService(KualiModuleService kualiModuleService)