1 /**
2 * Copyright 2005-2013 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.krad.workflow.service;
17
18 import org.kuali.rice.kew.api.document.attribute.DocumentAttribute;
19 import org.kuali.rice.kew.docsearch.SearchableAttributeValue;
20 import org.kuali.rice.krad.bo.BusinessObject;
21 import org.kuali.rice.krad.datadictionary.RoutingTypeDefinition;
22 import org.kuali.rice.krad.datadictionary.WorkflowAttributes;
23 import org.kuali.rice.krad.document.Document;
24
25 import java.util.List;
26 import java.util.Map;
27
28 /**
29 * A service which will resolve workflow attributes into the proper data for routing qualifier resolution
30 */
31 public interface WorkflowAttributePropertyResolutionService {
32
33 /**
34 * Generates a List of Map<String, String> data from the data on the document for the given WorkflowAttributeDefinitions
35 * @param document the document to gather data from
36 * @param routingTypeDefinition
37 * @return a List of populated Map<String, String> data
38 */
39 public abstract List<Map<String, String>> resolveRoutingTypeQualifiers(Document document, RoutingTypeDefinition routingTypeDefinition);
40
41 /**
42 * Given a document, returns the searchable attribute values to index for it
43 * @param document the document to find indexable searchable attribute values for
44 * @param workflowAttributes the WorkflowAttributes data dictionary metadata which contains the searchable attributes to index
45 * @return a List of SearchableAttributeValue objects for index
46 */
47 public abstract List<DocumentAttribute> resolveSearchableAttributeValues(Document document, WorkflowAttributes workflowAttributes);
48
49 /**
50 * Retrieves an object, the child of another given object passed in as a parameter, by the given path
51 * @param object an object to find a child object of
52 * @param path the path to that child object
53 * @return the child object
54 */
55 public abstract Object getPropertyByPath(Object object, String path);
56
57 /**
58 * Determines the type of the field which is related to the given attribute name on instances of the given business object class
59 * @param businessObjectClass the class of the business object which has an attribute
60 * @param attributeName the name of the attribute
61 * @return the String constrant representing what Field#fieldDataType this represents
62 */
63 public abstract String determineFieldDataType(Class<? extends BusinessObject> businessObjectClass, String attributeName);
64
65 /**
66 * Using the type of the sent in value, determines what kind of SearchableAttributeValue implementation should be passed back
67 * @param attributeKey
68 * @param value
69 * @return
70 */
71 public DocumentAttribute buildSearchableAttribute(Class<? extends BusinessObject> businessObjectClass, String attributeKey, Object value);
72
73 }