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

java.lang.Object
  extended by org.kuali.rice.kns.service.impl.DataDictionaryServiceImpl
All Implemented Interfaces:
DataDictionaryService

public class DataDictionaryServiceImpl
extends Object
implements DataDictionaryService

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


Field Summary
private  DataDictionary dataDictionary
           
private  DataDictionaryMap dataDictionaryMap
           
private  KualiConfigurationService kualiConfigurationService
           
private  KualiModuleService kualiModuleService
           
private static org.apache.log4j.Logger LOG
           
private  KualiWorkflowInfo workflowInfoService
           
 
Constructor Summary
DataDictionaryServiceImpl()
          Default constructor.
DataDictionaryServiceImpl(DataDictionary dataDictionary)
           
 
Method Summary
 void addDataDictionaryLocation(String location)
           
 void addDataDictionaryLocations(List<String> locations)
           
 Set<InactivationBlockingMetadata> getAllInactivationBlockingDefinitions(Class inactivationBlockedBusinessObjectClass)
          Returns all of the inactivation blocks registered for a particular business object
 ControlDefinition getAttributeControlDefinition(Class businessObjectClass, 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
private  AttributeDefinition getAttributeDefinition(String entryName, String attributeName)
           
 String getAttributeDescription(Class businessObjectClass, String attributeName)
          detailed help text for attribute
 String getAttributeDescription(String entryName, String attributeName)
          detailed help text for attribute
 String getAttributeErrorLabel(Class businessObjectClass, 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
 BigDecimal getAttributeExclusiveMin(String entryName, String attributeName)
           
 Boolean getAttributeForceUppercase(Class businessObjectClass, 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 businessObjectClass, 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
 BigDecimal getAttributeInclusiveMax(String entryName, String attributeName)
           
 String getAttributeLabel(Class businessObjectClass, 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 businessObjectClass, 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.
 AttributeSecurity getAttributeSecurity(String entryName, String attributeName)
          the AttributeSecurity object defined for the attribute's data value
 String getAttributeShortLabel(Class businessObjectClass, 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 businessObjectClass, 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 businessObjectClass, 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 businessObjectClass, 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 businessObjectClass, 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
private  CollectionDefinition getCollectionDefinition(String entryName, String collectionName)
           
 String getCollectionDescription(Class businessObjectClass, 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 businessObjectClass)
          the element label to be used for displaying the collection.
 String getCollectionLabel(Class businessObjectClass, 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 businessObjectClass, 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 businessObjectClass, String collectionName)
          short help text for collection
 String getCollectionSummary(String entryName, String collectionName)
          short help text for collection
 DataDictionary getDataDictionary()
           
 Map getDataDictionaryMap()
           
 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.
 KualiConfigurationService getKualiConfigurationService()
           
 KualiModuleService getKualiModuleService()
           
 Class<? extends PromptBeforeValidation> getPromptBeforeValidationClass(String docTypeName)
           
 Map<String,String> getRelationshipAttributeMap(String entryName, String relationshipName)
          returns a Map that specifies the attributes of the relationship
private  RelationshipDefinition getRelationshipDefinition(String entryName, String relationshipName)
           
 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.
 KualiWorkflowInfo getWorkflowInfoService()
           
 boolean hasRelationship(String entryName, String relationshipName)
          Determines whether there is a relationship defined for the given entry with the given name
 Boolean isAttributeDefined(Class businessObjectClass, 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 businessObjectClass, 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 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.
 void setKualiConfigurationService(KualiConfigurationService kualiConfigurationService)
           
 void setKualiModuleService(KualiModuleService kualiModuleService)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

private static final org.apache.log4j.Logger LOG

dataDictionary

private DataDictionary dataDictionary

dataDictionaryMap

private DataDictionaryMap dataDictionaryMap

kualiConfigurationService

private KualiConfigurationService kualiConfigurationService

kualiModuleService

private KualiModuleService kualiModuleService

workflowInfoService

private KualiWorkflowInfo workflowInfoService
Constructor Detail

DataDictionaryServiceImpl

public DataDictionaryServiceImpl()
Default constructor.


DataDictionaryServiceImpl

public DataDictionaryServiceImpl(DataDictionary dataDictionary)
Method Detail

setBaselinePackages

public void setBaselinePackages(List baselinePackages)
                         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:
setBaselinePackages in interface DataDictionaryService
Throws:
IOException
See Also:
org.kuali.rice.kns.service.DataDictionaryService#setBaselinePackages(java.lang.String)

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.kns.service.BusinessObjectDictionaryService#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.kns.service.BusinessObjectDictionaryService#getAttributeSize(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.kns.service.BusinessObjectDictionaryService#getAttributeMaxLength(java.lang.String)

getAttributeExclusiveMin

public BigDecimal 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 BigDecimal 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.kns.service.BusinessObjectDictionaryService#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.kns.service.BusinessObjectDictionaryService#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.kns.service.BusinessObjectDictionaryService#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.kns.service.BusinessObjectDictionaryService#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.kns.service.BusinessObjectDictionaryService#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.kns.service.BusinessObjectDictionaryService#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.kns.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.kns.service.BusinessObjectDictionaryService#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.kns.service.BusinessObjectDictionaryService#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:
org.kuali.rice.kns.service.BusinessObjectDictionaryService#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:
org.kuali.rice.kns.service.BusinessObjectDictionaryService#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.kns.service.BusinessObjectDictionaryService#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:
org.kuali.rice.kns.service.BusinessObjectDictionaryService#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:
org.kuali.rice.kns.service.BusinessObjectDictionaryService#getCollectionShortLabel(java.lang.Class, java.lang.String)

getCollectionElementLabel

public String getCollectionElementLabel(String entryName,
                                        String collectionName,
                                        Class businessObjectClass)
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.kns.service.BusinessObjectDictionaryService#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:
org.kuali.rice.kns.service.BusinessObjectDictionaryService#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:
org.kuali.rice.kns.service.BusinessObjectDictionaryService#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

private AttributeDefinition getAttributeDefinition(String entryName,
                                                   String attributeName)
Parameters:
objectClass -
attributeName -
Returns:
AttributeDefinition for the given objectClass and attribute name, or null if there is none
Throws:
IllegalArgumentException - if the given Class is null or is not a BusinessObject class

getCollectionDefinition

private CollectionDefinition getCollectionDefinition(String entryName,
                                                     String collectionName)
Parameters:
entryName -
collectionName -
Returns:
CollectionDefinition for the given entryName and collectionName, or null if there is none

getRelationshipDefinition

private RelationshipDefinition getRelationshipDefinition(String entryName,
                                                         String relationshipName)
Parameters:
entryName -
relationshipName -
Returns:
RelationshipDefinition for the given entryName and relationshipName, or null if there is none

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
Returns:
a list of all DD defined mappings

getAttributeControlDefinition

public ControlDefinition getAttributeControlDefinition(Class businessObjectClass,
                                                       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 businessObjectClass,
                                      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 businessObjectClass,
                                          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 businessObjectClass,
                                                        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 businessObjectClass,
                                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 businessObjectClass,
                                     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 businessObjectClass,
                                     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 businessObjectClass,
                                     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 businessObjectClass,
                                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 businessObjectClass,
                                  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 businessObjectClass,
                                                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 businessObjectClass,
                                           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 businessObjectClass,
                                       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 businessObjectClass,
                                 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 businessObjectClass,
                                      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 businessObjectClass,
                                   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 businessObjectClass,
                                  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 businessObjectClass,
                                   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)

getPromptBeforeValidationClass

public Class<? extends PromptBeforeValidation> getPromptBeforeValidationClass(String docTypeName)
Specified by:
getPromptBeforeValidationClass in interface DataDictionaryService
Returns:
preRulesCheckClass associated with the given document's type
See Also:
DataDictionaryService.getPromptBeforeValidationClass(java.lang.String)

addDataDictionaryLocation

public void addDataDictionaryLocation(String location)
                               throws IOException
Throws:
IOException

addDataDictionaryLocations

public void addDataDictionaryLocations(List<String> locations)
                                throws IOException
Specified by:
addDataDictionaryLocations in interface DataDictionaryService
Throws:
IOException

getDataDictionaryMap

public Map getDataDictionaryMap()
Specified by:
getDataDictionaryMap in interface DataDictionaryService

setKualiConfigurationService

public void setKualiConfigurationService(KualiConfigurationService kualiConfigurationService)

getKualiConfigurationService

public KualiConfigurationService getKualiConfigurationService()

getKualiModuleService

public KualiModuleService getKualiModuleService()

setKualiModuleService

public void setKualiModuleService(KualiModuleService kualiModuleService)

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)

getWorkflowInfoService

public KualiWorkflowInfo getWorkflowInfoService()


Copyright © 2004-2011 The Kuali Foundation. All Rights Reserved.