org.kuali.rice.kns.service

Interface BusinessObjectMetaDataService

All Superinterfaces:

DataObjectMetaDataService

public interface BusinessObjectMetaDataService
extends DataObjectMetaDataService

Provides Metadata about a specific BusinessObject. Depending on the circumstance or type of BO it will retrieve the data it needs from either the DataDictionary or through the PersistenceStructureService

Author:

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

Method Summary

Modifier and Type	Method and Description
DataObjectRelationship	getBusinessObjectRelationship(BusinessObject bo, Class boClass, String attributeName, String attributePrefix, boolean keysOnly) Deprecated.
DataObjectRelationship	getBusinessObjectRelationship(BusinessObject bo, String attributeName) Deprecated.
DataObjectRelationship	getBusinessObjectRelationship(RelationshipDefinition ddReference, BusinessObject bo, Class boClass, String attributeName, String attributePrefix, boolean keysOnly)
RelationshipDefinition	getBusinessObjectRelationshipDefinition(BusinessObject bo, String attributeName)
RelationshipDefinition	getBusinessObjectRelationshipDefinition(Class c, String attributeName)
List<DataObjectRelationship>	getBusinessObjectRelationships(BusinessObject bo) Deprecated.
List<DataObjectRelationship>	getBusinessObjectRelationships(Class<? extends BusinessObject> boClass) Deprecated.
Collection<String>	getCollectionNames(BusinessObject bo) This method returns a list of collection names a business object contains
String	getForeignKeyFieldName(Class businessObjectClass, String attributeName, String targetName) Deprecated.
Collection<String>	getInquirableFieldNames(Class boClass, String sectionTitle) This method returns a list of inquirable field names
List<String>	getLookupableFieldNames(Class boClass) This method returns a list of lookupable fields
String	getLookupFieldDefaultValue(Class businessObjectClass, String attributeName) This method looks up the default value for a given attribute and returns it
Class	getLookupFieldDefaultValueFinderClass(Class businessObjectClass, String attributeName) This method returns the value finder class for a given attribute
String	getLookupFieldQuickfinderParameterString(Class businessObjectClass, String attributeName) This method looks up the quickfinder parameter string for a given attribute and returns it.
Class<? extends ValueFinder>	getLookupFieldQuickfinderParameterStringBuilderClass(Class businessObjectClass, String attributeName) This method returns the quickfinder parameter string builder class for a given attribute.
Map<String,Class>	getReferencesForForeignKey(BusinessObject businessObject, String attributeName) Deprecated.
boolean	isAttributeInquirable(Class boClass, String attributeName, String sectionTitle) This method determines if a given field(attribute) is inquirable or not This handles both nested and non-nested attributes
boolean	isAttributeLookupable(Class boClass, String attributeName) This method determines if a given field(attribute) is lookupable or not This handles both nested and non-nested attributes
boolean	isInquirable(Class boClass) This method determines if a given business object is inquirable
boolean	isLookupable(Class boClass) This method determines if a given business object is lookupable

Methods inherited from interface org.kuali.rice.krad.service.DataObjectMetaDataService

areNotesSupported, equalsByPrimaryKeys, getDataObjectIdentifierString, getDataObjectRelationship, getDataObjectRelationships, getDictionaryRelationship, getPrimaryKeyFieldValues, getPrimaryKeyFieldValues, getTitleAttribute, hasLocalInquiry, hasLocalLookup, listPrimaryKeyFieldNames

Method Detail

getBusinessObjectRelationship

DataObjectRelationship getBusinessObjectRelationship(RelationshipDefinition ddReference,
                                                     BusinessObject bo,
                                                     Class boClass,
                                                     String attributeName,
                                                     String attributePrefix,
                                                     boolean keysOnly)

getBusinessObjectRelationshipDefinition

RelationshipDefinition getBusinessObjectRelationshipDefinition(Class c,
                                                               String attributeName)

getBusinessObjectRelationshipDefinition

RelationshipDefinition getBusinessObjectRelationshipDefinition(BusinessObject bo,
                                                               String attributeName)

getInquirableFieldNames

Collection<String> getInquirableFieldNames(Class boClass,
                                           String sectionTitle)

This method returns a list of inquirable field names

Parameters:

bo -

Returns:

a collection of inquirable field names

getLookupableFieldNames

List<String> getLookupableFieldNames(Class boClass)

This method returns a list of lookupable fields

Parameters:

bo -

Returns:

a collection of lookupable fields

getLookupFieldDefaultValue

String getLookupFieldDefaultValue(Class businessObjectClass,
                                  String attributeName)

This method looks up the default value for a given attribute and returns it

Parameters:

businessObjectClass -

attributeName -

Returns:

default value for an attribute

getLookupFieldDefaultValueFinderClass

Class getLookupFieldDefaultValueFinderClass(Class businessObjectClass,
                                            String attributeName)

This method returns the value finder class for a given attribute

Parameters:

businessObjectClass -

attributeName -

Returns:

value finder class

getLookupFieldQuickfinderParameterString

String getLookupFieldQuickfinderParameterString(Class businessObjectClass,
                                                String attributeName)

This method looks up the quickfinder parameter string for a given attribute and returns it. See FieldDefinition.getQuickfinderParameterString().

Parameters:

businessObjectClass -

attributeName -

Returns:

default values for attributes

getLookupFieldQuickfinderParameterStringBuilderClass

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

This method returns the quickfinder parameter string builder class for a given attribute. See FieldDefinition.getQuickfinderParameterStringBuilderClass().

Parameters:

businessObjectClass -

attributeName -

Returns:

value finder class

getCollectionNames

Collection<String> getCollectionNames(BusinessObject bo)

This method returns a list of collection names a business object contains

Parameters:

bo -

Returns:

isAttributeInquirable

boolean isAttributeInquirable(Class boClass,
                              String attributeName,
                              String sectionTitle)

This method determines if a given field(attribute) is inquirable or not This handles both nested and non-nested attributes

Parameters:

bo -

attributeName -

sectionTitle -

Returns:

true if field is inquirable

isInquirable

boolean isInquirable(Class boClass)

This method determines if a given business object is inquirable

Parameters:

bo -

Returns:

true if bo is inquirable

isAttributeLookupable

boolean isAttributeLookupable(Class boClass,
                              String attributeName)

This method determines if a given field(attribute) is lookupable or not This handles both nested and non-nested attributes

Parameters:

bo -

attributeName -

Returns:

true if field is lookupable

isLookupable

boolean isLookupable(Class boClass)

This method determines if a given business object is lookupable

Parameters:

bo -

Returns:

true if bo is lookupable

getBusinessObjectRelationship

@Deprecated
DataObjectRelationship getBusinessObjectRelationship(BusinessObject bo,
                                                                 String attributeName)

Deprecated.

This method will return a class that is related to the parent BO (either through the DataDictionary or through the PersistenceStructureService)

Parameters:

bo -

attributes -

Returns:

related class

getBusinessObjectRelationship

@Deprecated
DataObjectRelationship getBusinessObjectRelationship(BusinessObject bo,
                                                                 Class boClass,
                                                                 String attributeName,
                                                                 String attributePrefix,
                                                                 boolean keysOnly)

Deprecated.

getBusinessObjectRelationships

@Deprecated
List<DataObjectRelationship> getBusinessObjectRelationships(BusinessObject bo)

Deprecated.

Get all the business object relationships for the given business object. These relationships may be defined at the ORM-layer or within the data dictionary.

getBusinessObjectRelationships

@Deprecated
List<DataObjectRelationship> getBusinessObjectRelationships(Class<? extends BusinessObject> boClass)

Deprecated.

Get all the business object relationships for the given class. These relationships may be defined at the ORM-layer or within the data dictionary.

getReferencesForForeignKey

@Deprecated
Map<String,Class> getReferencesForForeignKey(BusinessObject businessObject,
                                                         String attributeName)

Deprecated.

This method accepts a business object and one of its foreign key attribute names. It returns a map that has a foreign key attribute name as a key and its respective related class as value. If the passed in attributeName is not a foreign key, this method will return an empty map.

Parameters:

BusinessObject - businessObject

String - attributeName

Returns:

Map

getForeignKeyFieldName

@Deprecated
String getForeignKeyFieldName(Class businessObjectClass,
                                          String attributeName,
                                          String targetName)

Deprecated.

This method ...

Parameters:

businessObjectClass -

attributeName -

targetName -

Returns: