org.kuali.rice.kns.service
Interface BusinessObjectDictionaryService

All Known Implementing Classes:

BusinessObjectDictionaryServiceImpl

public interface BusinessObjectDictionaryService

This interface defines the API for the interacting with the data dictionary.

Method Summary

Boolean	areNotesSupported(Class businessObjectClass)
boolean	disableSearchButtonsInLookup(Class businessObjectClass) Indicates whether the search and clear buttons should be disabled based on the data dictionary configuration
Boolean	forceInquiryFieldInquiry(Class businessObjectClass, String attributeName) returns boolean indicating whether inquiry result field marked to force an inquiry
Boolean	forceInquiryFieldLookup(Class businessObjectClass, String attributeName) returns boolean indicating whether lookup search field marked to force an inquiry
Boolean	forceLookupFieldLookup(Class businessObjectClass, String attributeName) returns boolean indicating whether lookup search field marked to force a lookup
Boolean	forceLookupResultFieldInquiry(Class businessObjectClass, String attributeName) returns boolean indicating whether lookup result field marked to force an inquiry
List	getBusinessObjectClassnames() the list of business object class names being maintained
String	getExtraButtonParams(Class businessObjectClass) return parameters for optional extra button
String	getExtraButtonSource(Class businessObjectClass) source for optional extra button
List<String>	getGroupByAttributesForEffectiveDating(Class businessObjectClass) Returns the list of attributes that should be used for grouping when determing the current status of a business object that implements InactivateableFromTo
Class	getInquirableClass(Class businessObjectClass) the class to be used for building inquiry pages.
<T extends BusinessObject> InquiryAuthorizer	getInquiryAuthorizer(Class<T> businessObjectClass)
String	getInquiryFieldAdditionalDisplayAttributeName(Class businessObjectClass, String attributeName) returns String giving additional display attribute name for inquiry field if configured, or null
String	getInquiryFieldAlternateDisplayAttributeName(Class businessObjectClass, String attributeName) returns String giving alternate display attribute name for inquiry field if configured, or null
List	getInquiryFieldNames(Class businessObjectClass, String sectionTitle) the list defined as inquiry fields for the business object and inquiry section.
<T extends BusinessObject> InquiryPresentationController	getInquiryPresentationController(Class<T> businessObjectClass)
List	getInquirySections(Class businessObjectClass) the list defined as inquiry sections for the business object.
String	getInquiryTitle(Class businessObjectClass) the text to be displayed for the title of business object inquiry.
String	getLookupableID(Class businessObjectClass) the Lookupable implementation id for the associated Lookup, if one has been specified
Boolean	getLookupAttributeReadOnly(Class businessObjectClass, String attributeName) indicates whether a field is read only for a lookup
Boolean	getLookupAttributeRequired(Class businessObjectClass, String attributeName) indicates whether a field is required for a lookup
List	getLookupDefaultSortFieldNames(Class businessObjectClass) the property names of the bo used to sort the initial result set
String	getLookupFieldAdditionalDisplayAttributeName(Class businessObjectClass, String attributeName) returns String giving additional display attribute name for lookup field if configured, or null
String	getLookupFieldAlternateDisplayAttributeName(Class businessObjectClass, String attributeName) returns String giving alternate display attribute name for lookup field if configured, or null
String	getLookupFieldDefaultValue(Class businessObjectClass, String attributeName) returns String indicating the default search value for the lookup field
Class	getLookupFieldDefaultValueFinderClass(Class businessObjectClass, String attributeName) returns Class used to generate a lookup field default value
List	getLookupFieldNames(Class businessObjectClass) the list defined as lookup fields for the business object.
String	getLookupFieldQuickfinderParameterString(Class businessObjectClass, String attributeName) See FieldDefinition.getQuickfinderParameterString().
Class<? extends ValueFinder>	getLookupFieldQuickfinderParameterStringBuilderClass(Class businessObjectClass, String attributeName) returns Class used to generate quickfinder lookup field default values.
String	getLookupMenuBar(Class businessObjectClass) menu bar html defined for the business object.
Integer	getLookupNumberOfColumns(Class businessObjectClass)
Integer	getLookupResultFieldMaxLength(Class businessObjectClass, String resultFieldName) This method returns the maximum display length of the value of the given field in the lookup results.
List<String>	getLookupResultFieldNames(Class businessObjectClass) the list defined as lookup result fields for the business object.
Boolean	getLookupResultFieldTotal(Class businessObjectClass, String attributeName) returns boolean indicating whether lookup result field should be totaled
Boolean	getLookupResultFieldUseShortLabel(Class businessObjectClass, String attributeName) returns boolean indicating whether lookup result field to use shortLabel
Integer	getLookupResultSetLimit(Class businessObjectClass) returns String indicating the result set limit for the lookup
String	getLookupTitle(Class businessObjectClass) the text to be displayed for the title of business object lookup.
String	getMaintainableLabel(Class businessObjectClass) the text to be displayed for the title of business object maintenance document.
String	getSearchIconOverride(Class businessObjectClass) returns String indicating the location of the lookup icon.
String	getTitleAttribute(Class businessObjectClass) the attribute to be associated with for object level markings
Boolean	isExportable(Class businessObjectClass) indicates whether business object has an exporter defined
Boolean	isInquirable(Class businessObjectClass) indicates whether business object has inquiry defined
Boolean	isLookupable(Class businessObjectClass) indicates whether business object has lookup defined
boolean	isLookupFieldTreatWildcardsAndOperatorsAsLiteral(Class businessObjectClass, String attributeName) returns whether on a lookup, field/attribute values with wildcards and operators should treat them as literal characters
boolean	isLookupFieldTriggerOnChange(Class businessObjectClass, String attributeName) Indicates whether a lookup field has been configured to trigger on value change
Boolean	isMaintainable(Class businessObjectClass) indicates whether business object has maintainable defined
Boolean	noDirectInquiryFieldLookup(Class businessObjectClass, String attributeName) returns boolean indicating whether lookup search field marked to not do a direct inquiry
Boolean	noInquiryFieldInquiry(Class businessObjectClass, String attributeName) returns boolean indicating whether inquiry result field marked to not do an inquiry
Boolean	noLookupFieldLookup(Class businessObjectClass, String attributeName) returns boolean indicating whether lookup search field marked to not do a lookup
Boolean	noLookupResultFieldInquiry(Class businessObjectClass, String attributeName) returns boolean indicating whether lookup result field marked to not do an inquiry
void	performForceUppercase(BusinessObject bo) This method takes any business object and recursively walks through it checking to see if any attributes need to be forced to uppercase based on settings in the data dictionary
Boolean	tranlateCodesInInquiry(Class businessObjectClass)
Boolean	tranlateCodesInLookup(Class businessObjectClass)

Method Detail

getInquiryPresentationController

<T extends BusinessObject> InquiryPresentationController getInquiryPresentationController(Class<T> businessObjectClass)

getInquiryAuthorizer

<T extends BusinessObject> InquiryAuthorizer getInquiryAuthorizer(Class<T> businessObjectClass)

getBusinessObjectClassnames

List getBusinessObjectClassnames()

the list of business object class names being maintained

isLookupable

Boolean isLookupable(Class businessObjectClass)

indicates whether business object has lookup defined

isInquirable

Boolean isInquirable(Class businessObjectClass)

indicates whether business object has inquiry defined

isMaintainable

Boolean isMaintainable(Class businessObjectClass)

indicates whether business object has maintainable defined

isExportable

Boolean isExportable(Class businessObjectClass)

indicates whether business object has an exporter defined

getLookupFieldNames

List getLookupFieldNames(Class businessObjectClass)

the list defined as lookup fields for the business object.

getLookupTitle

String getLookupTitle(Class businessObjectClass)

the text to be displayed for the title of business object lookup.

getLookupMenuBar

String getLookupMenuBar(Class businessObjectClass)

menu bar html defined for the business object.

getExtraButtonSource

String getExtraButtonSource(Class businessObjectClass)

source for optional extra button

getExtraButtonParams

String getExtraButtonParams(Class businessObjectClass)

return parameters for optional extra button

getLookupDefaultSortFieldNames

List getLookupDefaultSortFieldNames(Class businessObjectClass)

the property names of the bo used to sort the initial result set

getLookupResultFieldNames

List<String> getLookupResultFieldNames(Class businessObjectClass)

the list defined as lookup result fields for the business object.

getLookupResultFieldMaxLength

Integer getLookupResultFieldMaxLength(Class businessObjectClass,
                                      String resultFieldName)

This method returns the maximum display length of the value of the given field in the lookup results. While the actual value may be longer than the specified length, this value specifies the maximum length substring that should be displayed. It is up to the UI layer to intepret the results of the field

Parameters:

businessObjectClass -

resultFieldName -

Returns:

the maximum length of the lookup results field that should be displayed. Returns null if this value has not been defined. If negative, denotes that the is maximum length is unlimited.

forceLookupResultFieldInquiry

Boolean forceLookupResultFieldInquiry(Class businessObjectClass,
                                      String attributeName)

returns boolean indicating whether lookup result field marked to force an inquiry

noLookupResultFieldInquiry

Boolean noLookupResultFieldInquiry(Class businessObjectClass,
                                   String attributeName)

returns boolean indicating whether lookup result field marked to not do an inquiry

forceLookupFieldLookup

Boolean forceLookupFieldLookup(Class businessObjectClass,
                               String attributeName)

returns boolean indicating whether lookup search field marked to force a lookup

forceInquiryFieldLookup

Boolean forceInquiryFieldLookup(Class businessObjectClass,
                                String attributeName)

returns boolean indicating whether lookup search field marked to force an inquiry

noLookupFieldLookup

Boolean noLookupFieldLookup(Class businessObjectClass,
                            String attributeName)

returns boolean indicating whether lookup search field marked to not do a lookup

noDirectInquiryFieldLookup

Boolean noDirectInquiryFieldLookup(Class businessObjectClass,
                                   String attributeName)

returns boolean indicating whether lookup search field marked to not do a direct inquiry

forceInquiryFieldInquiry

Boolean forceInquiryFieldInquiry(Class businessObjectClass,
                                 String attributeName)

returns boolean indicating whether inquiry result field marked to force an inquiry

noInquiryFieldInquiry

Boolean noInquiryFieldInquiry(Class businessObjectClass,
                              String attributeName)

returns boolean indicating whether inquiry result field marked to not do an inquiry

getLookupResultFieldUseShortLabel

Boolean getLookupResultFieldUseShortLabel(Class businessObjectClass,
                                          String attributeName)

returns boolean indicating whether lookup result field to use shortLabel

getLookupResultFieldTotal

Boolean getLookupResultFieldTotal(Class businessObjectClass,
                                  String attributeName)

returns boolean indicating whether lookup result field should be totaled

getLookupFieldDefaultValue

String getLookupFieldDefaultValue(Class businessObjectClass,
                                  String attributeName)

returns String indicating the default search value for the lookup field

getLookupFieldDefaultValueFinderClass

Class getLookupFieldDefaultValueFinderClass(Class businessObjectClass,
                                            String attributeName)

returns Class used to generate a lookup field default value

getLookupFieldQuickfinderParameterString

String getLookupFieldQuickfinderParameterString(Class businessObjectClass,
                                                String attributeName)

See FieldDefinition.getQuickfinderParameterString(). returns String indicating the default search value for the lookup field.

getLookupFieldQuickfinderParameterStringBuilderClass

Class<? extends ValueFinder> getLookupFieldQuickfinderParameterStringBuilderClass(Class businessObjectClass,
                                                                                  String attributeName)

returns Class used to generate quickfinder lookup field default values. See FieldDefinition.getQuickfinderParameterStringBuilderClass().

getLookupResultSetLimit

Integer getLookupResultSetLimit(Class businessObjectClass)

returns String indicating the result set limit for the lookup

getLookupNumberOfColumns

Integer getLookupNumberOfColumns(Class businessObjectClass)

Returns:

number of search columns configured for the lookup associated with the class

getSearchIconOverride

String getSearchIconOverride(Class businessObjectClass)

returns String indicating the location of the lookup icon.

getLookupAttributeRequired

Boolean getLookupAttributeRequired(Class businessObjectClass,
                                   String attributeName)

indicates whether a field is required for a lookup

getLookupAttributeReadOnly

Boolean getLookupAttributeReadOnly(Class businessObjectClass,
                                   String attributeName)

indicates whether a field is read only for a lookup

getInquiryFieldNames

List getInquiryFieldNames(Class businessObjectClass,
                          String sectionTitle)

the list defined as inquiry fields for the business object and inquiry section.

getInquirySections

List getInquirySections(Class businessObjectClass)

the list defined as inquiry sections for the business object.

getInquiryTitle

String getInquiryTitle(Class businessObjectClass)

the text to be displayed for the title of business object inquiry.

getInquirableClass

Class getInquirableClass(Class businessObjectClass)

the class to be used for building inquiry pages.

getMaintainableLabel

String getMaintainableLabel(Class businessObjectClass)

the text to be displayed for the title of business object maintenance document.

getTitleAttribute

String getTitleAttribute(Class businessObjectClass)

the attribute to be associated with for object level markings

getLookupableID

String getLookupableID(Class businessObjectClass)

the Lookupable implementation id for the associated Lookup, if one has been specified

performForceUppercase

void performForceUppercase(BusinessObject bo)

This method takes any business object and recursively walks through it checking to see if any attributes need to be forced to uppercase based on settings in the data dictionary

Parameters:

bo -

areNotesSupported

Boolean areNotesSupported(Class businessObjectClass)

isLookupFieldTreatWildcardsAndOperatorsAsLiteral

boolean isLookupFieldTreatWildcardsAndOperatorsAsLiteral(Class businessObjectClass,
                                                         String attributeName)

returns whether on a lookup, field/attribute values with wildcards and operators should treat them as literal characters

Parameters:

businessObjectClass -

attributeName -

Returns:

getLookupFieldAlternateDisplayAttributeName

String getLookupFieldAlternateDisplayAttributeName(Class businessObjectClass,
                                                   String attributeName)

returns String giving alternate display attribute name for lookup field if configured, or null

getInquiryFieldAlternateDisplayAttributeName

String getInquiryFieldAlternateDisplayAttributeName(Class businessObjectClass,
                                                    String attributeName)

returns String giving alternate display attribute name for inquiry field if configured, or null

getLookupFieldAdditionalDisplayAttributeName

String getLookupFieldAdditionalDisplayAttributeName(Class businessObjectClass,
                                                    String attributeName)

returns String giving additional display attribute name for lookup field if configured, or null

getInquiryFieldAdditionalDisplayAttributeName

String getInquiryFieldAdditionalDisplayAttributeName(Class businessObjectClass,
                                                     String attributeName)

returns String giving additional display attribute name for inquiry field if configured, or null

tranlateCodesInLookup

Boolean tranlateCodesInLookup(Class businessObjectClass)

Parameters:

businessObjectClass - - business object class for lookup definition

Returns:

Boolean indicating whether translating of codes is configured to true in lookup definition

tranlateCodesInInquiry

Boolean tranlateCodesInInquiry(Class businessObjectClass)

Parameters:

businessObjectClass - - business object class for inquiry definition

Returns:

Boolean indicating whether translating of codes is configured to true in inquiry definition

isLookupFieldTriggerOnChange

boolean isLookupFieldTriggerOnChange(Class businessObjectClass,
                                     String attributeName)

Indicates whether a lookup field has been configured to trigger on value change

Parameters:

businessObjectClass - - Class for business object to lookup

attributeName - - name of attribute in the business object to check configuration for

Returns:

true if field is configured to trigger on value change, false if not

disableSearchButtonsInLookup

boolean disableSearchButtonsInLookup(Class businessObjectClass)

Indicates whether the search and clear buttons should be disabled based on the data dictionary configuration

Parameters:

businessObjectClass - - business object class for lookup definition

Returns:

Boolean indicating whether disable search buttons is configured to true in lookup definition

getGroupByAttributesForEffectiveDating

List<String> getGroupByAttributesForEffectiveDating(Class businessObjectClass)

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

Parameters:

businessObjectClass - - business object class to get configured list for

Returns:

List of string attribute names that gives the group by list