org.kuali.rice.kns.service
Interface WorkflowAttributePropertyResolutionService

All Known Implementing Classes:

WorkflowAttributePropertyResolutionServiceImpl

public interface WorkflowAttributePropertyResolutionService

A service which will resolve workflow attributes into the proper data for routing qualifier resolution

Author:

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

Method Summary

DocumentAttribute	buildSearchableAttribute(Class<? extends BusinessObject> businessObjectClass, String attributeKey, Object value) Using the type of the sent in value, determines what kind of SearchableAttributeValue implementation should be passed back
String	determineFieldDataType(Class<? extends BusinessObject> businessObjectClass, String attributeName) Determines the type of the field which is related to the given attribute name on instances of the given business object class
Object	getPropertyByPath(Object object, String path) Retrieves an object, the child of another given object passed in as a parameter, by the given path
List<Map<String,String>>	resolveRoutingTypeQualifiers(Document document, RoutingTypeDefinition routingTypeDefinition) Generates a List of Map data from the data on the document for the given WorkflowAttributeDefinitions
List<DocumentAttribute>	resolveSearchableAttributeValues(Document document, WorkflowAttributes workflowAttributes) Given a document, returns the searchable attribute values to index for it

Method Detail

resolveRoutingTypeQualifiers

List<Map<String,String>> resolveRoutingTypeQualifiers(Document document,
                                                      RoutingTypeDefinition routingTypeDefinition)

Generates a List of Map data from the data on the document for the given WorkflowAttributeDefinitions

Parameters:

document - the document to gather data from

routingTypeDefinition -

Returns:

a List of populated Map data

resolveSearchableAttributeValues

List<DocumentAttribute> resolveSearchableAttributeValues(Document document,
                                                         WorkflowAttributes workflowAttributes)

Given a document, returns the searchable attribute values to index for it

Parameters:

document - the document to find indexable searchable attribute values for

workflowAttributes - the WorkflowAttributes data dictionary metadata which contains the searchable attributes to index

Returns:

a List of SearchableAttributeValue objects for index

getPropertyByPath

Object getPropertyByPath(Object object,
                         String path)

Retrieves an object, the child of another given object passed in as a parameter, by the given path

Parameters:

object - an object to find a child object of

path - the path to that child object

Returns:

the child object

determineFieldDataType

String determineFieldDataType(Class<? extends BusinessObject> businessObjectClass,
                              String attributeName)

Determines the type of the field which is related to the given attribute name on instances of the given business object class

Parameters:

businessObjectClass - the class of the business object which has an attribute

attributeName - the name of the attribute

Returns:

the String constrant representing what Field#fieldDataType this represents

buildSearchableAttribute

DocumentAttribute buildSearchableAttribute(Class<? extends BusinessObject> businessObjectClass,
                                           String attributeKey,
                                           Object value)

Using the type of the sent in value, determines what kind of SearchableAttributeValue implementation should be passed back

Parameters:

attributeKey -

value -

Returns: