org.kuali.rice.kew.docsearch.xml
Class StandardGenericXMLSearchableAttribute

java.lang.Object
  org.kuali.rice.kew.docsearch.xml.StandardGenericXMLSearchableAttribute

All Implemented Interfaces:

Serializable, SearchableAttribute, GenericXMLSearchableAttribute, XmlConfiguredAttribute

Direct Known Subclasses:

KualiXmlSearchableAttributeImpl

public class StandardGenericXMLSearchableAttribute
extends Object
implements GenericXMLSearchableAttribute

implementation of GenericXMLSearchableAttribute.

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.kuali.rice.kew.docsearch.SearchableAttribute

DATA_TYPE_DATE, DATA_TYPE_FLOAT, DATA_TYPE_LONG, DATA_TYPE_STRING, DEFAULT_RANGE_SEARCH_LOWER_BOUND_LABEL, DEFAULT_RANGE_SEARCH_UPPER_BOUND_LABEL, DEFAULT_SEARCHABLE_ATTRIBUTE_TYPE_NAME, RANGE_LOWER_BOUND_PROPERTY_PREFIX, RANGE_UPPER_BOUND_PROPERTY_PREFIX, SEARCH_WILDCARD_CHARACTER, SEARCH_WILDCARD_CHARACTER_REGEX_ESCAPED, SEARCHABLE_ATTRIBUTE_BASE_CLASS_LIST

Constructor Summary

StandardGenericXMLSearchableAttribute()

Method Summary

Element	getConfigXML()
Map	getParamMap()
String	getSearchContent(DocumentSearchContext documentSearchContext) this gives the xml representation of the attribute; returning a standard java xml object might be a better approach here
List<Row>	getSearchingRows(DocumentSearchContext documentSearchContext) this will return a list of field objects to be rendered in the docsearch interface
List	getSearchStorageValues(DocumentSearchContext documentSearchContext) this will return the loaded data objects for storage in workflow�s database to be related to the document the attributes xml content was loaded with
void	setParamMap(Map paramMap)
void	setRuleAttribute(RuleAttribute ruleAttribute)
List	validateUserSearchInputs(Map paramMap, DocumentSearchContext documentSearchContext) this will return a list of error objects if the user has made an input error

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardGenericXMLSearchableAttribute

public StandardGenericXMLSearchableAttribute()

Method Detail

setRuleAttribute

public void setRuleAttribute(RuleAttribute ruleAttribute)

Specified by:

setRuleAttribute in interface XmlConfiguredAttribute

setParamMap

public void setParamMap(Map paramMap)

Specified by:

setParamMap in interface GenericXMLSearchableAttribute

getParamMap

public Map getParamMap()

Specified by:

getParamMap in interface GenericXMLSearchableAttribute

getSearchContent

public String getSearchContent(DocumentSearchContext documentSearchContext)

Description copied from interface: SearchableAttribute

this gives the xml representation of the attribute; returning a standard java xml object might be a better approach here

Specified by:

getSearchContent in interface SearchableAttribute

Returns:

getSearchStorageValues

public List getSearchStorageValues(DocumentSearchContext documentSearchContext)

Description copied from interface: SearchableAttribute

this will return the loaded data objects for storage in workflow�s database to be related to the document the attributes xml content was loaded with

Specified by:

getSearchStorageValues in interface SearchableAttribute

Returns:

getSearchingRows

public List<Row> getSearchingRows(DocumentSearchContext documentSearchContext)

Description copied from interface: SearchableAttribute

this will return a list of field objects to be rendered in the docsearch interface

Specified by:

getSearchingRows in interface SearchableAttribute

Returns:

validateUserSearchInputs

public List validateUserSearchInputs(Map paramMap,
                                     DocumentSearchContext documentSearchContext)

Description copied from interface: SearchableAttribute

this will return a list of error objects if the user has made an input error

Specified by:

validateUserSearchInputs in interface SearchableAttribute

Parameters:

paramMap - map

documentSearchContext - document search context

Returns:

list of workflow attribute validation errors

getConfigXML

public Element getConfigXML()