org.kuali.rice.kns.service
Interface BusinessObjectMetaDataService

All Known Implementing Classes:

BusinessObjectMetaDataServiceImpl

public interface BusinessObjectMetaDataService

This class 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

Method Summary

BusinessObjectRelationship	getBusinessObjectRelationship(org.kuali.rice.kns.bo.BusinessObject bo, Class boClass, String attributeName, String attributePrefix, boolean keysOnly)
BusinessObjectRelationship	getBusinessObjectRelationship(org.kuali.rice.kns.bo.BusinessObject bo, String attributeName) This method will return a class that is related to the parent BO (either through the DataDictionary or through the PersistenceStructureService)
BusinessObjectRelationship	getBusinessObjectRelationship(RelationshipDefinition ddReference, org.kuali.rice.kns.bo.BusinessObject bo, Class boClass, String attributeName, String attributePrefix, boolean keysOnly)
RelationshipDefinition	getBusinessObjectRelationshipDefinition(org.kuali.rice.kns.bo.BusinessObject bo, String attributeName)
RelationshipDefinition	getBusinessObjectRelationshipDefinition(Class c, String attributeName)
List<BusinessObjectRelationship>	getBusinessObjectRelationships(org.kuali.rice.kns.bo.BusinessObject bo) Get all the business object relationships for the given business object.
List<BusinessObjectRelationship>	getBusinessObjectRelationships(Class<? extends org.kuali.rice.kns.bo.BusinessObject> boClass) Get all the business object relationships for the given class.
Collection<String>	getCollectionNames(org.kuali.rice.kns.bo.BusinessObject bo) This method returns a list of collection names a business object contains
String	getForeignKeyFieldName(Class businessObjectClass, String attributeName, String targetName) This method ...
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(org.kuali.rice.kns.bo.BusinessObject businessObject, String attributeName) This method accepts a business object and one of its foreign key attribute names.
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
List	listPrimaryKeyFieldNames(Class clazz) This method returns a list of primary keys for the passed in class.

Method Detail

getBusinessObjectRelationship

BusinessObjectRelationship getBusinessObjectRelationship(RelationshipDefinition ddReference,
                                                         org.kuali.rice.kns.bo.BusinessObject bo,
                                                         Class boClass,
                                                         String attributeName,
                                                         String attributePrefix,
                                                         boolean keysOnly)

getBusinessObjectRelationshipDefinition

RelationshipDefinition getBusinessObjectRelationshipDefinition(Class c,
                                                               String attributeName)

getBusinessObjectRelationshipDefinition

RelationshipDefinition getBusinessObjectRelationshipDefinition(org.kuali.rice.kns.bo.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(org.kuali.rice.kns.bo.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

BusinessObjectRelationship getBusinessObjectRelationship(org.kuali.rice.kns.bo.BusinessObject bo,
                                                         String attributeName)

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

BusinessObjectRelationship getBusinessObjectRelationship(org.kuali.rice.kns.bo.BusinessObject bo,
                                                         Class boClass,
                                                         String attributeName,
                                                         String attributePrefix,
                                                         boolean keysOnly)

getBusinessObjectRelationships

List<BusinessObjectRelationship> getBusinessObjectRelationships(org.kuali.rice.kns.bo.BusinessObject bo)

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

List<BusinessObjectRelationship> getBusinessObjectRelationships(Class<? extends org.kuali.rice.kns.bo.BusinessObject> boClass)

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

Map<String,Class> getReferencesForForeignKey(org.kuali.rice.kns.bo.BusinessObject businessObject,
                                             String attributeName)

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

listPrimaryKeyFieldNames

List listPrimaryKeyFieldNames(Class clazz)

This method returns a list of primary keys for the passed in class.

Parameters:

clazz -

Returns:

getForeignKeyFieldName

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

This method ...

Parameters:

businessObjectClass -

attributeName -

targetName -

Returns: