org.kuali.rice.kns.workflow.attribute

Class DataDictionarySearchableAttribute

java.lang.Object

org.kuali.rice.kns.workflow.attribute.DataDictionarySearchableAttribute

All Implemented Interfaces:

org.kuali.rice.kew.framework.document.attribute.SearchableAttribute

public class DataDictionarySearchableAttribute
extends Object
implements org.kuali.rice.kew.framework.document.attribute.SearchableAttribute

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_TYPE_BOOLEAN

Constructor Summary

Constructors

Constructor and Description
DataDictionarySearchableAttribute()

Method Summary

Modifier and Type	Method and Description
protected List<Row>	createFieldRowsForBusinessObject(Class<? extends BusinessObject> businessObjectClass) Creates a list of search fields, one for each primary key of the maintained business object
protected List<Row>	createFieldRowsForWorkflowAttributes(WorkflowAttributes attrs)
List<DocumentAttribute>	extractDocumentAttributes(ExtensionDefinition extensionDefinition, DocumentWithContent documentWithContent)
protected List<DocumentAttribute>	findAllDocumentAttributesForGlobalBusinessObject(GlobalBusinessObject globalBO)
protected DocumentAttribute	generateSearchableAttributeFromChange(PersistableBusinessObject changeToPersist)
String	generateSearchContent(ExtensionDefinition extensionDefinition, String documentTypeName, WorkflowAttributeDefinition attributeDefinition)
protected Class<? extends BusinessObject>	getBusinessObjectClass(String documentTypeName) Returns the class of the object being maintained by the given maintenance document type name
protected Class<? extends Maintainable>	getMaintainableClass(String documentTypeName) Returns the maintainable of the object being maintained by the given maintenance document type name
List<RemotableAttributeField>	getSearchFields(ExtensionDefinition extensionDefinition, String documentTypeName)
protected List<Row>	getSearchingRows(String documentTypeName) Produces legacy KNS rows to use for search attributes.
protected List<DocumentAttribute>	parsePrimaryKeyValuesFromDocument(Class<? extends BusinessObject> businessObjectClass, MaintenanceDocument document)
protected DocumentAttribute	parseSearchableAttributeValueForPrimaryKey(String propertyName, Class<? extends BusinessObject> businessObjectClass, MaintenanceDocument document) Creates a searchable attribute value for the given property name out of the document XML
protected GlobalBusinessObject	retrieveGlobalBusinessObject(String documentNumber, Class<? extends BusinessObject> businessObjectClass)
protected MaintenanceDocumentEntry	retrieveMaintenanceDocumentEntry(String documentTypeName) Retrieves the maintenance document entry for the given document type name
protected void	retrieveValidationErrorsFromGlobalVariables(List<RemotableAttributeError> validationErrors) Retrieves validation errors from GlobalVariables MessageMap and appends to the given list of RemotableAttributeError
List<RemotableAttributeError>	validateDocumentAttributeCriteria(ExtensionDefinition extensionDefinition, DocumentSearchCriteria documentSearchCriteria)

Methods inherited from class java.lang.Object

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

Field Detail

DATA_TYPE_BOOLEAN

public static final String DATA_TYPE_BOOLEAN

See Also:

Constant Field Values

Constructor Detail

DataDictionarySearchableAttribute

public DataDictionarySearchableAttribute()

Method Detail

generateSearchContent

public String generateSearchContent(ExtensionDefinition extensionDefinition,
                                    String documentTypeName,
                                    WorkflowAttributeDefinition attributeDefinition)

Specified by:

generateSearchContent in interface org.kuali.rice.kew.framework.document.attribute.SearchableAttribute

extractDocumentAttributes

public List<DocumentAttribute> extractDocumentAttributes(ExtensionDefinition extensionDefinition,
                                                         DocumentWithContent documentWithContent)

Specified by:

extractDocumentAttributes in interface org.kuali.rice.kew.framework.document.attribute.SearchableAttribute

getSearchFields

public List<RemotableAttributeField> getSearchFields(ExtensionDefinition extensionDefinition,
                                                     String documentTypeName)

Specified by:

getSearchFields in interface org.kuali.rice.kew.framework.document.attribute.SearchableAttribute

getSearchingRows

protected List<Row> getSearchingRows(String documentTypeName)

Produces legacy KNS rows to use for search attributes. This method was left intact to help ease conversion until KNS is replaced with KRAD.

validateDocumentAttributeCriteria

public List<RemotableAttributeError> validateDocumentAttributeCriteria(ExtensionDefinition extensionDefinition,
                                                                       DocumentSearchCriteria documentSearchCriteria)

Specified by:

validateDocumentAttributeCriteria in interface org.kuali.rice.kew.framework.document.attribute.SearchableAttribute

retrieveValidationErrorsFromGlobalVariables

protected void retrieveValidationErrorsFromGlobalVariables(List<RemotableAttributeError> validationErrors)

Retrieves validation errors from GlobalVariables MessageMap and appends to the given list of RemotableAttributeError

Parameters:

validationErrors - list to append validation errors

createFieldRowsForWorkflowAttributes

protected List<Row> createFieldRowsForWorkflowAttributes(WorkflowAttributes attrs)

parsePrimaryKeyValuesFromDocument

protected List<DocumentAttribute> parsePrimaryKeyValuesFromDocument(Class<? extends BusinessObject> businessObjectClass,
                                                                    MaintenanceDocument document)

parseSearchableAttributeValueForPrimaryKey

protected DocumentAttribute parseSearchableAttributeValueForPrimaryKey(String propertyName,
                                                                       Class<? extends BusinessObject> businessObjectClass,
                                                                       MaintenanceDocument document)

Creates a searchable attribute value for the given property name out of the document XML

Parameters:

propertyName - the name of the property to return

businessObjectClass - the class of the business object maintained

document - the document XML

Returns:

a generated SearchableAttributeValue, or null if a value could not be created

getBusinessObjectClass

protected Class<? extends BusinessObject> getBusinessObjectClass(String documentTypeName)

Returns the class of the object being maintained by the given maintenance document type name

Parameters:

documentTypeName - the name of the document type to look up the maintained business object for

Returns:

the class of the maintained business object

getMaintainableClass

protected Class<? extends Maintainable> getMaintainableClass(String documentTypeName)

Returns the maintainable of the object being maintained by the given maintenance document type name

Parameters:

documentTypeName - the name of the document type to look up the maintained business object for

Returns:

the Maintainable of the maintained business object

retrieveMaintenanceDocumentEntry

protected MaintenanceDocumentEntry retrieveMaintenanceDocumentEntry(String documentTypeName)

Retrieves the maintenance document entry for the given document type name

Parameters:

documentTypeName - the document type name to look up the data dictionary document entry for

Returns:

the corresponding data dictionary entry for a maintenance document

retrieveGlobalBusinessObject

protected GlobalBusinessObject retrieveGlobalBusinessObject(String documentNumber,
                                                            Class<? extends BusinessObject> businessObjectClass)

findAllDocumentAttributesForGlobalBusinessObject

protected List<DocumentAttribute> findAllDocumentAttributesForGlobalBusinessObject(GlobalBusinessObject globalBO)

generateSearchableAttributeFromChange

protected DocumentAttribute generateSearchableAttributeFromChange(PersistableBusinessObject changeToPersist)

createFieldRowsForBusinessObject

protected List<Row> createFieldRowsForBusinessObject(Class<? extends BusinessObject> businessObjectClass)

Creates a list of search fields, one for each primary key of the maintained business object

Parameters:

businessObjectClass - the class of the maintained business object

Returns:

a List of KEW search fields