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.kns.service;
17
18 import org.kuali.rice.kew.api.document.attribute.DocumentAttribute;
19 import org.kuali.rice.krad.bo.BusinessObject;
20 import org.kuali.rice.krad.datadictionary.RoutingTypeDefinition;
21 import org.kuali.rice.krad.datadictionary.WorkflowAttributes;
22 import org.kuali.rice.krad.document.Document;
23
24 import java.util.List;
25 import java.util.Map;
26
27 /**
28 * A service which will resolve workflow attributes into the proper data for routing qualifier resolution
29 *
30 * @author Kuali Rice Team (rice.collab@kuali.org)
31 */
32 public interface WorkflowAttributePropertyResolutionService {
33
34 /**
35 * Generates a List of Map<String, String> data from the data on the document for the given WorkflowAttributeDefinitions
36 * @param document the document to gather data from
37 * @param routingTypeDefinition
38 * @return a List of populated Map<String, String> data
39 */
40 public abstract List<Map<String, String>> resolveRoutingTypeQualifiers(Document document, RoutingTypeDefinition routingTypeDefinition);
41
42 /**
43 * Given a document, returns the searchable attribute values to index for it
44 * @param document the document to find indexable searchable attribute values for
45 * @param workflowAttributes the WorkflowAttributes data dictionary metadata which contains the searchable attributes to index
46 * @return a List of SearchableAttributeValue objects for index
47 */
48 public abstract List<DocumentAttribute> resolveSearchableAttributeValues(Document document, WorkflowAttributes workflowAttributes);
49
50 /**
51 * Retrieves an object, the child of another given object passed in as a parameter, by the given path
52 * @param object an object to find a child object of
53 * @param path the path to that child object
54 * @return the child object
55 */
56 public abstract Object getPropertyByPath(Object object, String path);
57
58 /**
59 * Determines the type of the field which is related to the given attribute name on instances of the given business object class
60 * @param businessObjectClass the class of the business object which has an attribute
61 * @param attributeName the name of the attribute
62 * @return the String constrant representing what Field#fieldDataType this represents
63 */
64 public abstract String determineFieldDataType(Class<? extends BusinessObject> businessObjectClass, String attributeName);
65
66 /**
67 * Using the type of the sent in value, determines what kind of SearchableAttributeValue implementation should be passed back
68 * @param attributeKey
69 * @param value
70 * @return
71 */
72 public DocumentAttribute buildSearchableAttribute(Class<? extends BusinessObject> businessObjectClass, String attributeKey, Object value);
73
74 }