org.kuali.rice.kns.web.ui

Class FieldBridge

java.lang.Object

org.kuali.rice.kns.web.ui.FieldBridge

Deprecated.

KNS Struts deprecated, use KRAD and the Spring MVC framework.

@Deprecated
public class FieldBridge
extends Object

Constructor Summary

Constructors

Constructor and Description
FieldBridge() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
static List<Field>	constructContainerField(CollectionDefinitionI collectionDefinition, String parents, BusinessObject o, boolean hideAdd, int numberOfColumns, String collName, List<Field> collFields) Deprecated. This method handles setting up a container field not including the add fields
static BusinessObjectDictionaryService	getBusinessObjectDictionaryService() Deprecated.
static DataDictionaryService	getDataDictionaryService() Deprecated.
static MaintenanceDocumentDictionaryService	getMaintenanceDocumentDictionaryService() Deprecated.
static List<Field>	getNewFormFields(CollectionDefinitionI collectionDefinition, BusinessObject o, Maintainable m, List<String> displayedFieldNames, Set<String> conditionallyRequiredMaintenanceFields, StringBuffer containerRowErrorKey, String parents, boolean hideAdd, int numberOfColumns) Deprecated. This method will return a new form for adding in a BO for a collection.
static List<Field>	getNewFormFields(MaintainableCollectionDefinition collectionDefinition, BusinessObject o, Maintainable m, List<String> displayedFieldNames, Set<String> conditionallyRequiredMaintenanceFields, StringBuffer containerRowErrorKey, int numberOfColumns) Deprecated. Call getNewFormFields with no parents.
static PersistenceStructureService	getPersistenceStructureService() Deprecated.
protected static boolean	isMaintenanceFieldLevelHelpDisabled(Maintainable m, MaintainableFieldDefinition fieldDefinition) Deprecated. Determines whether field level help is disabled for the field corresponding to the dataObjectClass and attribute name If this value is true and isMaintenanceFieldLevelHelpEnabled(Maintainable, MaintainableFieldDefinition) returns false, then the field level help will not be rendered.
protected static boolean	isMaintenanceFieldLevelHelpEnabled(Maintainable m, MaintainableFieldDefinition fieldDefinition) Deprecated. Determines whether field level help is enabled for the field corresponding to the dataObjectClass and attribute name If this value is true, then the field level help will be enabled.
static void	populateFieldFromBusinessObject(Field field, BusinessObject bo) Deprecated. Uses reflection to populate the rows of the inquiry from the business object value.
static void	setupField(Field field, FieldDefinitionI definition, Set<String> conditionallyRequiredMaintenanceFields) Deprecated. Sets additional properties for MaintainableField(s)
static Field	toField(FieldDefinition d, BusinessObject o, Section s) Deprecated. Create a Field for display on an Inquiry screen.
static Field	toField(MaintainableItemDefinition id, MaintainableSectionDefinition sd, BusinessObject o, Maintainable m, Section s, List<String> displayedFieldNames, Set<String> conditionallyRequiredMaintenanceFields) Deprecated. This method creates a Field for display on a Maintenance Document.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldBridge

public FieldBridge()

Deprecated.

Method Detail

setupField

public static final void setupField(Field field,
              FieldDefinitionI definition,
              Set<String> conditionallyRequiredMaintenanceFields)

Deprecated.

Sets additional properties for MaintainableField(s)

Parameters:

field - The field to populate.

definition - The DD specification for the field.

populateFieldFromBusinessObject

public static final void populateFieldFromBusinessObject(Field field,
                                   BusinessObject bo)

Deprecated.

Uses reflection to populate the rows of the inquiry from the business object value. Also formats if needed.

Parameters:

field - The Field to populate.

bo - The BusinessObject from which the Field will be popualated.

isMaintenanceFieldLevelHelpEnabled

protected static boolean isMaintenanceFieldLevelHelpEnabled(Maintainable m,
                                         MaintainableFieldDefinition fieldDefinition)

Deprecated.

Determines whether field level help is enabled for the field corresponding to the dataObjectClass and attribute name If this value is true, then the field level help will be enabled. If false, then whether a field is enabled is determined by the value returned by isMaintenanceFieldLevelHelpDisabled(Maintainable, MaintainableFieldDefinition) and the system-wide parameter setting. Note that if a field is read-only, that may cause field-level help to not be rendered.

Parameters:

businessObjectClass - the looked up class

attributeName - the attribute for the field

Returns:

true if field level help is enabled, false if the value of this method should NOT be used to determine whether this method's return value affects the enablement of field level help

isMaintenanceFieldLevelHelpDisabled

protected static boolean isMaintenanceFieldLevelHelpDisabled(Maintainable m,
                                          MaintainableFieldDefinition fieldDefinition)

Deprecated.

Determines whether field level help is disabled for the field corresponding to the dataObjectClass and attribute name If this value is true and isMaintenanceFieldLevelHelpEnabled(Maintainable, MaintainableFieldDefinition) returns false, then the field level help will not be rendered. If both this and isMaintenanceFieldLevelHelpEnabled(Maintainable, MaintainableFieldDefinition) return false, then the system-wide setting will determine whether field level help is enabled. Note that if a field is read-only, that may cause field-level help to not be rendered.

Parameters:

businessObjectClass - the looked up class

attributeName - the attribute for the field

Returns:

true if field level help is disabled, false if the value of this method should NOT be used to determine whether this method's return value affects the enablement of field level help

toField

public static final Field toField(MaintainableItemDefinition id,
            MaintainableSectionDefinition sd,
            BusinessObject o,
            Maintainable m,
            Section s,
            List<String> displayedFieldNames,
            Set<String> conditionallyRequiredMaintenanceFields)
                           throws InstantiationException,
                                  IllegalAccessException

Deprecated.

This method creates a Field for display on a Maintenance Document.

Parameters:

id - The DD definition for the Field (can be a Collection).

sd - The DD definition for the Section in which the field will be displayed.

o - The BusinessObject will be populated from this BO.

m -

s - The Section in which the Field will be displayed.

autoFillDefaultValues - Should default values be filled in?

autoFillBlankRequiredValues - Should values be filled in for fields that are required but which were left blank when submitting the form from the UI?

displayedFieldNames - What fields are being displayed on the form in the UI?

Returns:

Throws:

InstantiationException

IllegalAccessException

getNewFormFields

public static final List<Field> getNewFormFields(CollectionDefinitionI collectionDefinition,
                           BusinessObject o,
                           Maintainable m,
                           List<String> displayedFieldNames,
                           Set<String> conditionallyRequiredMaintenanceFields,
                           StringBuffer containerRowErrorKey,
                           String parents,
                           boolean hideAdd,
                           int numberOfColumns)

Deprecated.

This method will return a new form for adding in a BO for a collection. This should be customized in a subclass so the default behavior is to return nothing.

Parameters:

collectionDefinition - The DD definition for the Collection.

o - The BusinessObject form which the new Fields will be populated.

document - MaintenanceDocument instance which we ar building fields for

m -

displayedFieldNames - What Fields are being displayed on the form in the UI?

containerRowErrorKey - The error key for the Container/Collection used for displaying error messages.

parents -

hideAdd - Should the add line be hidden when displaying this Collection/Container in the UI?

numberOfColumns - How many columns the Fields in the Collection will be split into when displaying them in the UI.

Returns:

The List of new Fields.

constructContainerField

public static List<Field> constructContainerField(CollectionDefinitionI collectionDefinition,
                                  String parents,
                                  BusinessObject o,
                                  boolean hideAdd,
                                  int numberOfColumns,
                                  String collName,
                                  List<Field> collFields)

Deprecated.

This method handles setting up a container field not including the add fields

Parameters:

collectionDefinition -

parents -

o -

hideAdd -

numberOfColumns -

collName -

collFields -

Returns:

getNewFormFields

public static final List<Field> getNewFormFields(MaintainableCollectionDefinition collectionDefinition,
                           BusinessObject o,
                           Maintainable m,
                           List<String> displayedFieldNames,
                           Set<String> conditionallyRequiredMaintenanceFields,
                           StringBuffer containerRowErrorKey,
                           int numberOfColumns)

Deprecated.

Call getNewFormFields with no parents.

See Also:

#getNewFormFields(org.kuali.rice.kns.datadictionary.CollectionDefinitionI, BusinessObject, Maintainable, List, StringBuffer, String, boolean, int)

toField

public static Field toField(FieldDefinition d,
            BusinessObject o,
            Section s)

Deprecated.

Create a Field for display on an Inquiry screen.

Parameters:

d - The DD definition for the Field.

o - The BusinessObject from which the Field will be populated.

s - The Section in which the Field will be displayed.

Returns:

The populated Field.

getDataDictionaryService

public static DataDictionaryService getDataDictionaryService()

Deprecated.

getPersistenceStructureService

public static PersistenceStructureService getPersistenceStructureService()

Deprecated.

getBusinessObjectDictionaryService

public static BusinessObjectDictionaryService getBusinessObjectDictionaryService()

Deprecated.

getMaintenanceDocumentDictionaryService

public static MaintenanceDocumentDictionaryService getMaintenanceDocumentDictionaryService()

Deprecated.